注释写法与Java文档生成_便签

单行注释

//你好，这里是注释内容,在Java里，注释直接写在代码行后面也不会有问题呢！

---

多行注释

/*
多行注释让我们可以
写
很
多
很
多
行
注
释
都
没
有
问
题。
*/

---

Java文档注释

/**
* @author 作者名称
* @version 版本号
* @since 最低支持的JDK版本
* @param 参数名称
* @return 返回值情况
* @throws 异常抛出情况
*/

---

Java文档生成

在目标路径使用cmd,输入

javadoc *.java

但这有可能会因为中文等等问题出现乱码，所以可以统一转换为编码为支持对应文字、字符的编码。

javadoc -encoding (编码格式) *.java //设定文档编码格式
javadoc -encoding (编码格式) -charset (编码格式) *.java //设定文档编码格式以及字符集编码格式

例子

转换为UTF-8编码格式

javadoc -encoding UTF-8 -charset UTF-8 *.java