Bagaimana untuk menjana dokumentasi menggunakan komen dokumentasi Java?

Kami tahu bahawa Java menyokong tiga jenis ulasan, iaitu ulasan satu baris, komen berbilang baris dan ulasan dokumen Mari kita lihat rupanya

//Barisan tunggal. komen

/*
Komen berbilang baris
*/

/**
*@...
*....
*Komen Dokumentasi
*/

Mungkin ramai newbie tidak faham kegunaan menulis komen ini.

Sebenarnya, ia adalah kerana pemula mempunyai jumlah kod yang kecil dan boleh mencari dan mengubah suainya dengan cepat tanpa ulasan

Apabila kod meningkat secara beransur-ansur, komen adalah perkara yang baik, bukan sahaja untuk. kejelasan mereka sendiri. Membaca kod dengan jelas juga merupakan kemudahan untuk ahli yang membangunkan projek dengan anda

Ingat, buang tabiat buruk tidak menulis komen! ! !

Jadi, inilah topik kita hari ini, apakah komen Doc?

Javadoc ialah teknologi yang disediakan oleh Sun Ia mengekstrak komen seperti kelas, kaedah, ahli, dll. daripada kod sumber program untuk membentuk dokumen bantuan API yang sepadan dengan kod sumber. Dalam erti kata lain, selagi anda menggunakan set teg tertentu sebagai ulasan semasa menulis atur cara, selepas atur cara ditulis, dokumentasi pembangunan atur cara boleh dibentuk pada masa yang sama melalui Javadoc.

Arahan javadoc digunakan untuk menjana dokumentasi API Cara menggunakannya: Gunakan baris arahan untuk memasukkan javadoc + nama fail.java dalam direktori tempat fail sasaran berada

Anda tidak perlu terjerat dalam teori-teori rumit ini Anda perlu memupuk Pemikiran, untuk memahami, memahami, mendalami, mengubahnya, memahaminya, berpegang kepada teori itu tidak berkesan!

Apabila kita menulis kod, terdapat piawaian Jika kod yang anda tulis boleh dijalankan, tetapi ia adalah kucar-kacir, tiada siapa yang sanggup menggunakannya kerana ia sukar untuk dikekalkan sebuah program yang mudah. ​​Dunia dalam talian, saya lebih suka memanggilnya sebagai karya seni, memerlukan ukiran anda yang teliti

Sesetengah orang mungkin berkata, bukankah ia hanya anotasi? Apa masalahnya?

Namun, komen Doc ini tidak sama dengan dua komen yang lain.

Spesifikasi ulasan dokumen

Format:

Anotasi dokumen yang ditulis pada kelas biasanya dibahagikan kepada tiga perenggan:

Perenggan pertama: perihalan ringkasan, biasanya Terangkan secara ringkas fungsi jenis ini dalam satu ayat atau perenggan, berakhir dengan titik bahasa Inggeris

Perenggan kedua: Penerangan terperinci, biasanya menggunakan satu atau lebih perenggan untuk menerangkan fungsi jenis ini secara terperinci, biasanya setiap perenggan berakhir dengan Tamat dengan tempoh Bahasa Inggeris

Perenggan ketiga: anotasi dokumen, digunakan untuk menandakan pengarang, masa penciptaan, kelas rujukan dan maklumat lain

Di sini saya ingin mengembangkan sedikit pengetahuan, komen Doc kami boleh menggunakan arahan Dos Atau alat IDE menjana dokumen Dokumen Dokumen ini ditulis dalam bahasa HTML, jadi anda boleh menambah beberapa kod HTML mudah dalam ulasan, seperti berikut

putus baris
<.>

Segmentasi

(ditulis sebelum perenggan)

Letakkan contoh rajah gaya:

Penggunaan simbol @

Apabila kami menulis ulasan Doc, tekan Enter terus selepas /**, dan bingkai ulasan berikut dan beberapa simbol @ akan dijana secara automatik Jadi apakah kegunaan simbol @ ini?

标签	描述	示例
@author	标识一个类的作者，一般用于类注释	@author description
@deprecated	指名一个过期的类或成员，表明该类或方法不建议使用	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	可能抛出异常的说明，一般用于方法注释	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数，一般用于方法注释	@param parameter-name explanation
@return	说明返回值类型，一般用于方法注释，不能出现再构造方法中	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过 writeObject() 和 writeExternal() 方法写的数据	@serialData description
@serialField	说明一个 ObjectStreamField 组件	@serialField name type description
@since	说明从哪个版本起开始有了这个函数	@since release
@throws	和 @exception 标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是 static 属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本，一般用于类注释	@version info

@Bahagian di belakang saya adalah dalam bahasa Inggeris, dan anda boleh menulis bahasa Cina, seperti @pengarang Xiaojian

Cara menjana dokumen Doc

Seperti yang kami katakan di atas, anda boleh tulis komen Doc Jana dokumen Doc, dan ia dalam format HTML, jadi bagaimana kita menjananya?

Pertama: Penjanaan arahan Dos

javadoc [pilihan] [nama pakej] [fail sumber]

Penjelasan format:

options mewakili pilihan arahan Javadoc;

packagenames mewakili nama pakej; (command prompt ), anda boleh melihat penggunaan dan pilihan Javadoc (dengan syarat JDK dipasang dan dikonfigurasikan). Adakah terdapat cara lain?

Kedua: Penjanaan alat IDE sourcefiles

Kita boleh menggunakan Eclipse atau IDEA untuk menjananya Saya tidak begitu menggunakan Eclipse, jadi izinkan saya menunjukkannya kepada anda menggunakan IDEA.

javadoc -help

名称	说明
-public	仅显示 public 类和成员
-protected	显示 protected/public 类和成员（默认值）
-package	显示 package/protected/public 类和成员
-private	显示所有类和成员
-d	输出文件的目标目录
-version	包含 @version 段
-author	包含 @author 段
-splitindex	将索引分为每个字母对应一个文件
-windowtitle	文档的浏览器窗口标题

Dalam JavaDoc di dalam alat, ia kelihatan seperti ini selepas memasukkannya

Direktori output mesti dipilih , jika tidak, ia akan dijana Tidak

Nota, kerana pengekodan Java berbeza daripada IDEA, jadi dalam lajur parameter arahan yang lain, anda perlu mengisi kandungan berikut

Selepas generasi, ia kelihatan seperti ini

Atas ialah kandungan terperinci Bagaimana untuk menjana dokumentasi menggunakan komen dokumentasi Java?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!