[JAVA] JAVA 文檔註釋

Java 程序設計環境

文檔註釋

javadoc

JDK中包含的javadoc工具能夠由源文件生成一個HTML文檔。

javadoc從如下幾個特性中抽取信息

• 包
• 公有類與接口
• 公有的和受保護的構造器及方法
• 公有的和受保護的域

包註釋：

1. 提供一個以package.html命名的HTML文件，body之間的全部文本都會被抽取出來。
2. 提供一個以package-info.java命名的文件，包含在/**和*/界定的javadoc註釋，跟隨在一個包語句以後，它不該該包含更多代碼或註釋。

生成文檔

mac-abeen:java abeen$ ls
alearnJava   doc_html     javasrc      package.html
mac-abeen:java abeen$ javadoc -d doc_html/  alearnJava
正在加載程序包alearnJava的源文件...
正在構造 Javadoc 信息...
標準 Doclet 版本 9.0.4
正在構建全部程序包和類的樹...
正在生成doc_html/alearnJava/BaseClassDescription.html...
正在生成doc_html/alearnJava/Employee.html...
正在生成doc_html/alearnJava/HelloSwing.html...
正在生成doc_html/alearnJava/Person.html...
正在生成doc_html/alearnJava/Reflect.html...
正在生成doc_html/alearnJava/Test.html...
正在生成doc_html/alearnJava/Welcome.html...
正在生成doc_html/alearnJava/package-frame.html...
正在生成doc_html/alearnJava/package-summary.html...
正在生成doc_html/alearnJava/package-tree.html...
正在生成doc_html/constant-values.html...
正在構建全部程序包和類的索引...
正在生成doc_html/overview-tree.html...
正在生成doc_html/index-all.html...
正在生成doc_html/deprecated-list.html...
正在構建全部類的索引...
正在生成doc_html/allclasses-frame.html...
正在生成doc_html/allclasses-frame.html...
正在生成doc_html/allclasses-noframe.html...
正在生成doc_html/allclasses-noframe.html...
正在生成doc_html/index.html...
正在生成doc_html/help-doc.html...
mac-abeen:java abeen$