1 文档注释
😎注释内容可以被JDK提供的工具javadoc所解析,生成一套以网页文件形式体现的该程序的说明文档,一般写在类。
2 基本格式
/**
*@author xxx
*@version xxx
*/
3 例子
⭐️该类中存有一个方法,gcd,用于求两数的最大公因数。
4 生成文档注释
格式:
javadoc -d 文件夹名 -author -version 文件名.java
例子:
【注意】如果注释中有中文,需要把编码转成GBK形式
在D盘对应的temp文件夹就可以找到生成的文档注释,打开index.html即可