【Java】Javadoc是什么？
编程学习日记
2020年11月22日
我曾经在课堂上根据Javadoc写过代码，但由于我没有理解Javadoc，所以需要总结一下。
Javadoc是一个工具。
在Java中，可以使用Javadoc注释来描述程序，并将程序的解释文档嵌入到源代码中。如果无法将程序说明嵌入到源代码中，则必须在一个单独的文件中管理程序说明文本，并且需要同时管理代码文件和说明文件。然而，在这种情况下，很可能会在修改时忘记更新文档，导致说明与实际操作不一致。通过巧妙地使用Javadoc，在修改代码时还可以修改文档。
当对类或方法进行概要描述时，Javadoc会根据此信息生成HTML格式的文档文件。
在写Javadoc注释时，需要在/**和*/之间写入注释。
/**
Javadocコメント
*/
样例代码
/**
* @author Tanaka Taro
* @version 1.0.0
*/
/**
* Javadoc解説用のメインクラス
*/
public class Main {
/**
* mainメソッド
* @param args 使用しない
*/
public static void main(String[] args) {
System.out.println("Hello World!");
}
}
Javadoc标签名称。
在Javadoc中，有一些带有@符号的标签可供使用。
タグ名 説明
@authorクラスの作成者 @version作成したプログラムのバージョン@paramメソッドの引数の説明 @returnメソッドの返り値の説明@throw発生する例外クラスを指定@serial直列化されたフィールドの説明@sesrialData直列化された状態でのデータ型と順序@since初めて作ったときのバージョン文献引用
如何：Java入门 – 解释注释类型和书写方法（也解释Javadoc标签规范）
