Java 的文档注释其实并没有那么简单
我们在写java 程序的只有三种注释方式：
“//” 后面跟上想要写入的注释
“/* */” 里面跟上想要写入的注释
“/** */” 说明注释，可以多行之间注释
说明注释允许我们在程序中嵌入关于程序的信息。
我们可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。说明注释，使我们更加方便的记录你的程序信息。
javadoc 标签
javadoc 工具软件识别以下标签：
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author description |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| {@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数 | @param parameter-name explanation |
| @return | 说明返回值类型 | @return explanation |
| @see | 指定一个到另一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | @since release |
| @throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定类的版本 | @version info |
文档注释
在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。
之后，你可以包含一个或多个各种各样的 @ 标签。
每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*).
多个相同类型的标签应该放成一组。
例如，如果你有三个 @see 标签，可以将它们一个接一个的放在一起。
下面是一个类的说明注释的实例：
/*** 这个类绘制一个条形图
* @author runoob
* @version 1.2
*/
javadoc 输出什么
javadoc 工具将你 Java 程序的源代码作为输入，输出一些包含你程序注释的，是HTML文件。
每一个类的信息将在独自的HTML文件里。
javadoc 也可以输出继承的树形结构和索引。
由于 javadoc 的实现不同，工作也可能不同，你需要检查你的 Java 开发系统的版本等细节，选择合适的 Javadoc 版本。
下面是具体的实例测试：
在目录下的终端处：输入javadoc 文件名.java即可开始输出文档。
发现出现问题：非法字符’\u3002’，
解决思路如下：修改我们的输出指令：javadoc -encoding utf-8 -charset utf-8 SquareNum.java
还是出现问题： @return 的用法无效
现在重新输入：javadoc -encoding utf-8 -charset utf-8 SquareNum.java
现在就可以正常生成了，那我们去查看一下吧。
成功导出啦！问题圆满解决
作者：Stevedash
发表于：2023年8月16日 20点56分
注：本文内容基于个人学习理解，如有错误或疏漏，欢迎指正。感谢阅读！如果觉得有帮助，请点赞和分享。
