manual rasmi doxygen

doxygen ialah alat bantu yang berguna untuk pengaturcara. Ia boleh memudahkan untuk menambahkan kod kelompok pada program. Ia serasi dengan bahasa pengaturcaraan arus perdana seperti C++, C, Java, Objective-C, Python, dll. Manual bahasa Cina doxygen yang disediakan oleh editor termasuk Ia mengandungi pengenalan asas, kemahiran tatabahasa dan kemahiran lanjutan, dsb., membolehkan anda bermula dengan cepat Jika anda memerlukannya, anda dialu-alukan untuk memuat turunnya.

Pengenalan asas

Doxygen sudah menyokong penjanaan fail direktori chm yang dikodkan ANSI (index.hhc) Doxygen biasanya digunakan untuk menjana dokumen Bahasa Inggeris memerlukan pengubahsuaian sistem pengekodan input dan output, yang boleh mengubah kaedah penghuraian dan menjana dokumen bahasa Cina. Walau bagaimanapun, anda mesti sedar bahawa Doxygen perlu melakukan penghuraian tatabahasa apabila mengekstrak maklumat daripada ulasan ini adalah berdasarkan bahasa Inggeris, dan adalah mustahil untuk menyokong bahasa Cina pada tahap ini.

Doxygen ialah penjana dokumentasi untuk bahasa C++, C, Java, Objective-C, Python, IDL (perisa CORBA dan Microsoft), Fortran, VHDL, PHP, C# dan D. Boleh dijalankan pada kebanyakan sistem seperti Unix, serta sistem pengendalian Mac OS X dan Microsoft Windows. Versi awal Doxygen meminjam beberapa kod daripada retak lama DOC++ kemudiannya, kod sumber Doxygen telah ditulis semula oleh Dimitri van Heesch.

Manual doxygen terbahagi kepada tiga bahagian, setiap bahagian mengandungi beberapa bab.

Bahagian pertama ialah panduan pengguna

1. Pemasangan, membincangkan cara memuat turun, menyusun dan memasang doxygen dalam platform anda.
2. Mari mulakan dengan memberitahu anda cara menjana dokumen doksigen pertama dengan cepat.
3. Dokumentasi kod, menunjukkan beberapa cara kod boleh didokumenkan.
4. Senaraikan, menunjukkan beberapa cara untuk membuat senarai.
5. Gabungan, menunjukkan cara menggabungkan beberapa kerja bersama-sama.
6. Mengandungi formula, menunjukkan cara memasukkan formula dalam dokumen.
7. Graf dan carta, menerangkan carta dan graf yang dihasilkan oleh doksigen.
8. Prapemprosesan dan penghuraian cara doksigen mengendalikan takrifan makro.
9. Hasilkan pautan automatik yang menunjukkan cara meletakkan pautan ke fail, kelas dan ahli dalam dokumen.
10. Format output, menunjukkan cara menjana pelbagai format output yang disokong oleh doxygen.
11. Cari, menunjukkan beberapa cara untuk mencari dalam dokumen HTML.
12. Output tersuai, analisa cara menjana output tersuai dalam doksigen.
13. Arahan tersuai, menunjukkan cara mentakrif dan menggunakan arahan tersuai dalam ulasan anda.
14. Sambung ke dokumen luaran dan terangkan cara membenarkan doxygen mencipta pautan ke dokumen yang dijana luaran.
15. FAQ, jawapan kepada soalan lazim.
16. Penyelesaian masalah, ia memberitahu anda apa yang perlu dilakukan apabila berlaku masalah.

Bahagian kedua adalah panduan rujukan

1. Ciri, menunjukkan gambaran keseluruhan fungsi doksigen.
2. Sejarah doksigen, memaklumkan doksigen tentang perubahan semasa proses pembangunan dan perkara yang telah dilakukannya.
3. Penggunaan doxygen, beritahu cara menggunakan doxygen.
4. Penggunaan Doxytag, beritahu cara menggunakan doxytag.
5. Penggunaan doxywizard, beritahu cara menggunakan doxywizard.
6. Penggunaan Installdox, beritahu cara menggunakan skrip installdox yang dihasilkan dalam doxygen jika anda menggunakan fail tag.
7. Konfigurasi, memberitahu cara melaraskan doksigen untuk menjana dokumentasi yang anda perlukan.
8. Kata perintah khas, memberikan gambaran keseluruhan arahan khas yang boleh digunakan dalam dokumen.
9. Perkataan arahan HTML, yang memberikan gambaran keseluruhan arahan HTML yang boleh digunakan dalam dokumen.
10. Kata perintah XML, yang memberikan gambaran keseluruhan arahan XML gaya C# yang boleh digunakan dalam dokumen.

Bahagian ketiga menyediakan beberapa maklumat untuk pembangun doksigen (diabaikan)

1. Struktur dalaman doksigen, memberikan gambaran keseluruhan struktur dalaman doksigen.
2. Format output modul Perl, menunjukkan cara menggunakan output PerlMod.
3. Pengantarabangsaan, menganalisis cara menambah sokongan output untuk bahasa baharu.