Java文档注释基本使用

网友投稿 531 2022-05-29

1. 文档注释

注释内容可以被JDK提供的工具javadoc所解析,生成一套以网页文件形式体现的该程序的说明文档,一般写在类中。

Java之文档注释基本使用

基本格式

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 工具软件识别以下标签:

Java

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:matlab快速入门(14):获取文档帮助
下一篇:使用Swagger2构建文档内容
相关文章