java文档注释——生成帮助文档

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中的注释方式

1. 行内注释用//
2. 多行注释/**/
3. 文档注释/** */ 上面的例子用的是文档注释

有了这个注释后，就可以用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.1workplaceDemosrcNoteDemo ote -encoding UTF-8 -charset UTF-8 -windowtitle “帮助文档” demo1.java

-charset用来设定字符集的编码 -windowtitile用来设置标题

方式二、在idea中直接生成

建议直接看这篇博客 https://blog..net/lsy0903/article/details/89893934

帮助文档

两个方法都可以生成帮助文档 最后生成的帮助文档长这个样子