java——帮助文档

2018-08-29  本文已影响0人  打死你的小乌龟
注释和嵌入式文档:

文档注释/** */ 独立文档以@开头 ,行内文档标签随意

javadoc只能为public和protected成员进行文档注释

javadoc -d . -version -author xxx.java
-d: 文档存放目录
.: 表示当前目录

标签示例

@see 引入其他类
{@link package.class#member lable}与see相似用于行内 并用label作为超链接文本 不用Also
{@docRoot}文档根目录的相对路径
{@inheritDoc}这个类最直接的基类中继承相关文档到文档注释中
@version
@author
@since指定程序代码最早使用的版本
@param用于方法文档中
@return 用在方法中返回值的含义
@throws异常

上一篇 下一篇

猜你喜欢

热点阅读