Java之文档注释基本使用
【摘要】 Java之文档注释基本使用
1. 文档注释
- 注释内容可以被JDK提供的工具
javadoc
所解析,生成一套以网页文件形式体现的该程序的说明文档,一般写在类中。 - 基本格式
javadoc -d 文件夹名 -xx -yy Demo1.java
xx,yy表示java代码里用到的 javadoc
标签,如:@author,@version
- 应用实例
/**
* @author xdr630
* @version 1.0
*/
public class Comment1 {
public static void main(String[] args) {
}
}
javadoc -d D:\JavaSE_Test\temp -author -version Comment1.java
- 打开 index.html
2. 常见 javadoc 标签
- javadoc 工具软件识别以下标签:
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)