Javadoc学习及使用
来源:互联网 发布:vscode c环境 编辑:程序博客网 时间:2024/06/11 13:00
简介
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档。
我们常用的java api doc就是Javadoc
如果编写Javadoc
注释格式
Java里通常支持三种格式注释。
// 第一种注释,双斜线,不支持换行/* 第二种,支持换行,这里面的都是注释 *//** * 第三种,在斜线后,有两个星号,这样的注释,便是Javadoc文档注释 *//** Javadoc文档注释也可以不换行 */
第三种,以/*开头的注释,便被称为Javadoc注释。
常用的tag
Tag功能介绍
@author
默认Javadoc是不显示@author Tag的内容的。
如果打算在Javadoc里显示@author的内容,可以在生成Javadoc的时候,添加参数 -tag author:a:”Author:”
@return
当Tag @return用在返回值为void的函数上或者构造函数,@return会被忽略
@see
@see “string”
如果在@see后面添加一段文本字符串,则不会生成连接。Javadoc 工具会根据文本前的双引号来进行识别
例如:
@see “The Java Programming Language”
生成的结果就是
See Also: "The Java Programming Language"
@see label
跳转到相应连接
@see package.class#member label
跳转到相应class的成员或class
@see 的查找
如果在class内,可以不加包和类的限定名
/** * @see #field * @see #method(Type, Type,...) */
在当前package或引用的package内查找
/** * @see Class#field * @see Class#method(Type, Type,...) */
在其他package内查找
/** * @see package.Class#field * @see package.Class#method(Type, Type,...) * @see package.Class */
@see Tag内的名称,的查找次序为:
1. 当前class或interface2. enclosing classes3. 父类或父接口4. 当前包5. 按import次序,查找import的包,class和interface
{@value}
{@value} 在生成的doc里,会用变量的真实值替换{@value}出现的地方。有两种用法:
一种是没有参数,只能用在final修饰的成员变量上
/** * The value of this constant is {@value}. */public static final String SCRIPT_START = "<script>"
使用参数,{@value package.class#field}。在生成的Javadoc内,会显示参数的值.
/** * * if equal {@value #TEST_STATIC} */ public boolean isTestString(String str){ }
{@code}
在这个Tag里,可以直接显示很多html里需要转义的字符,比如 <> &,同时,文本的字体也会以code的字体显示
IEAD快捷键
在函数上,输入/**后,回车就会自动生成
javadoc命令
javadoc -public -sourcepath ./api/src/main/java -d api_doc com.bfd.dw.api.service.schedule
参考资料
Oracle官网介绍
Oracle官网说明
- Javadoc学习及使用
- 学习使用javadoc
- javadoc的命令及使用
- javadoc的使用及eclipse生成
- javadoc的使用及eclipse生成
- javadoc 使用
- JavaDoc使用
- JavaDoc使用
- javadoc使用
- javadoc 使用
- Javadoc使用
- javadoc使用
- Javadoc说明及在Eclipse下的使用
- java学习笔记-使用javadoc命令生成API文档
- JavaDoc的学习笔记
- Javadoc注释学习
- javadoc学习经验分享
- JavaDoc文档编写学习
- Java:java.util.concurrent.atomic
- 凸优化学习笔记
- CocoaPod 使用指南
- HackerRank
- 谈一谈Java8的函数式编程(二) –Java8中的流(转)
- Javadoc学习及使用
- Debian本地源的创建及应用
- 广播流程2--发送广播
- 回归学习笔记
- 51nod 1102 面积最大的矩形(单调栈)
- Invalid bound statement (not found):
- 响应式布局初体验
- 谈一谈Java8的函数式编程 (三) --几道关于流的练习题(转)
- JDBC----用JDBC连接Mysql并进行增删改查操作