package NoteDemo;/**這個類里面有一個方法* @author zhang* @version java1.8*/public class demo1 {/*** 該類的無參構造方法*/public demo1() {}/***返回String值的add方法* @param a 加數* @param b 被加數* @return 經過if語句判斷后返回的String值*/public String add(int a,int b){if(a+b>10){return "big";}else{return "small";}} }

java中的注釋方式

行內注釋用//

多行注釋/**/

文檔注釋/** */
上面的例子用的是文檔注釋

有了這個注釋后，就可以用javadoc工具來讀取生成幫助文檔
通常在代碼的文檔注釋中，前幾行是關于這個類，方法，變量的相關描述。比如描述這個方法的作用，變量的含義等
后面幾行可以加上多個 @標簽，每一個 @ 標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標簽應該放成一組。

通常情況下，用的比較多的標簽是這四個，如果想查閱更多的標簽，可以去
https://www.runoob.com/java/java-documentation.html

文檔注釋寫好后，就可以用javadoc生成幫助文檔了

方式一、cmd

找到自己的java文件所在位置



最開始寫javadoc
-d后面的參數是幫助文檔的生成位置
-encoding后面的參數UTF-8是編碼，如果不加上這個會導致無法識別中文
最后跟上要輸入進javadoc的java文件

生成結束后，打開index.html文件

在cmd中使用javadoc的時候也可以增加更多的參數
javadoc -d F:\idea2018.1\workplace\Demo\src\NoteDemo\note -encoding UTF-8 -charset UTF-8 -windowtitle “幫助文檔” demo1.java

-charset用來設定字符集的編碼
-windowtitile用來設置標題

方式二、在idea中直接生成

建議直接看這篇博客
https://blog.csdn.net/lsy0903/article/details/89893934

幫助文檔

兩個方法都可以生成幫助文檔
最后生成的幫助文檔長這個樣子

總結

以上是生活随笔為你收集整理的java文档注释——生成帮助文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。