java中doc注释

javadoc注释官方参考网站1

javadoc注释官方参考网站2

一、注释:

{@inheritDoc}

// 代表从父类或父接口继承注释
{@inheritDoc}

二、javadoc命令参数:

javadoc: 错误 - 无效的标记: -Description
用法: javadoc [options] [packagenames] [sourcefiles] [@files]
-overview <file>          从 HTML 文件读取概览文档
-public                   仅显示 public 类和成员
-protected                显示 protected/public 类和成员 (默认值)
-package                  显示 package/protected/public 类和成员
-private                  显示所有类和成员
-help                     显示命令行选项并退出
-doclet <class>            通过替代 doclet 生成输出
-docletpath <path>        指定查找 doclet 类文件的位置
-sourcepath <pathlist>    指定查找源文件的位置
-classpath <pathlist>     指定查找用户类文件的位置
-exclude <pkglist>        指定要排除的程序包列表
-subpackages <subpkglist> 指定要递归加载的子程序包
-breakiterator            计算带有 BreakIterator 的第一个语句
-bootclasspath <pathlist> 覆盖由引导类加载器所加载的
			   类文件的位置
-source <release>         提供与指定发行版的源兼容性
-extdirs <dirlist>        覆盖所安装扩展的位置
-verbose                  输出有关 Javadoc 正在执行的操作的信息
-locale <name>            要使用的区域设置, 例如 en_US 或 en_US_WIN
-encoding <name>          源文件编码名称
-quiet                    不显示状态消息
-J<flag>                  直接将 <flag> 传递到运行时系统
-X                        输出非标准选项的提要

标准 Standard doclet 提供以下参数:
-d <directory>                    输出文件的目标目录
-use                              创建类和包用法页面
-version                          包含 @version 段
-author                           包含 @author 段
-docfilessubdirs                  递归复制 doc-file 子目录
-splitindex                       将索引拆分为每个字母一个文件
-windowtitle <text>               文档的浏览器窗口标题
-doctitle <html-code>             包含概述页面的标题
-header <html-code>               包含每个页面的页眉文本
-footer <html-code>               包含每个页面的页脚文本
-top    <html-code>               包含每个页面的顶部文本
-bottom <html-code>               包含每个页面的底部文本
-link <url>                       创建指向位于 <url> 的 javadoc 输出的链接
-linkoffline <url> <url2>         使用位于 <url2> 的包列表链接到位于 <url> 的文档
-excludedocfilessubdir <name1>:.. 排除具有指定名称的任何 doc-files 子目录
-group <name> <p1>:<p2>..         在概述页面中将指定的包分组到一起
-nocomment                        禁止描述和标记,仅生成声明
-nodeprecated                     不包含 @deprecated 信息
-noqualifier <name1>:<name2>:...  从输出中排除限定符列表
-nosince                          不包含 @since 信息
-notimestamp                      不包含隐藏的时间戳记
-nodeprecatedlist                 不生成不推荐的列表
-notree                           不生成类层次结构
-noindex                          不生成索引
-nohelp                           不生成帮助链接
-nonavbar                         不生成导航栏
-serialwarn                       生成有关 @serial 标记的警告
-tag <name>:<locations>:<header>  指定单一自变量定制标记
-taglet                           要注册的 Taglet 的标准名称
-tagletpath                       Taglet 的路径
-Xdocrootparent <url>             将文档注释中出现的 @docRoot(后跟 /..)替换为 <url>
-charset <charset>                用于跨平台查看所生成文档的字符集
-helpfile <file>                  包含帮助链接所链接到的文件
-linksource                       生成 HTML 格式的源代码
-sourcetab <tab length>           指定源代码中每个跳格所占用的空格数
-keywords                         在 HTML META 标记中包含包、类和成员信息
-stylesheetfile <path>            要更改所生成文档的样式的文件
-docencoding <name>               输出编码名称

 

### 如何在 Eclipse 中编写和使用 Java 文档注释 #### 编写文档注释 为了使 `javadoc` 工具能够识别并生成有用的 API 文档,应当遵循特定格式来书写文档注释。这种注释以 `/**` 开始,并以 `*/` 结束[^3]。 对于类、接口、成员变量以及方法的描述,推荐采用如下结构: ```java /** * 描述该元素的作用。 * * @param 参数名 对应参数的意义解释 * @return 返回值含义(仅限于方法) */ ``` 例如定义一个简单的加法函数时可这样添加注解: ```java public class Calculator { /** * 计算两个整数之和。 * * @param a 第一个加数 * @param b 第二个加数 * @return 两数相加之和 */ public int add(int a, int b){ return a+b; } } ``` #### 使用快捷键创建模板 为了让开发人员更加高效地工作,在 Eclipse IDE 下提供了方便的方式来快速插入上述样式的框架。默认情况下,“Source”菜单下的“Generate Element Comment”选项可以帮助完成这项任务;另外也可以自定义全局范围内的热键组合用于触发此功能[^5]。 进入设置界面路径为:“Windows -> Preferences”,接着定位到 “General -> Keys”。在这里查找名为 "Add Javadoc comment" 的命令,并为其指定一个新的加速按键配置方案即可实现个性化定制化需求。 #### 生成 HTML 格式的帮助文件 当项目中已经包含了足够的文档注释之后,就可以考虑将其转换成易于阅读的形式了——即HTML页面形式的帮助手册。这一步骤可通过两种途径达成目的:一种是从项目的上下文菜单里选取“Project->Generate Javadoc...”;另一种则是借助导出向导完成相同的操作流程:“File->Export...->Java->Javadoc”。 执行过程中需注意的是,默认状态下只会针对公开(`public`)级别的组件进行处理,若想让私密级别(`private`)的内容也出现在最终产物之中,则记得勾选相应的选项开关^-private^。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值