// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行,并写入 javadoc 文档
通常这种注释的多行写法如下:
/**
* .........
* .........
*/
javadoc -d 文档存放目录 -author -version 源文件名.java
这条命令编译一个名为"源文件名.java"的 java 源文件,并将生成的文档存放在"文档存放目录"指定的目录下,生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。
二. 文档注释的格式
1. 文档和文档注释的格式化
生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。
比如,需要换行时,不是敲入一个回车符,而是写入 <br>,如果要分段,就应该在段前写入 <p>。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。如
/**
* This is first line. <br>
***** This is second line. <br>
This is third line.
*/
2. 文档注释的三部分
先举例如下
/**
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
* @param b true 表示显示,false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}
第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
简述也在其中。这一点要记住了
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示,false 表示隐藏
* @return 没有返回值
三. 使用 javadoc 标记
javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
@author 作者名
@version 版本号
其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效
使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数,@return 描述方法的返回值,@exception 描述方法可能抛出的异常。它们的句法如下:
@param 参数名参数说明
@return 返回值说明
@exception 异常类名说明
四. javadoc 命令
用法:
javadoc [options] [packagenames] [sourcefiles]
选项:
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (缺省)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-d <directory> 输出文件的目标目录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题
javadoc 编译文档时可以给定包列表,也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下:
fancy.Editor
fancy.Test
fancy.editor.ECommand
fancy.editor.EDocument
fancy.editor.EView
可以直接编译类:
javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java
也可以是给出包名作为编译参数,如:javadoc fancy fancy.editor
可以自己看看这两种方法的区别
完善api-doc,用eclipse生成javadoc的时候发生“编码 GBK 的不可映射字符 ”其实是字符编码问题。
打开eclipse,project -> Generate javadoc 一项一项的选你要输出javadoc的项目,最后一步中VM设置行中加入以下代码
相关推荐
Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、...
Maven插件,用于从JAX-RS和Javadoc注释生成Swagger 这个Maven插件正在为基于JAX-RS的Java服务器生成Swagger API文档。 JAX-RS批注中未包含的其他信息放置在Javadoc注释中。 例 此处提供了一个使用javadoc2swagger-...
javadoc利用Java编译程序javac对程序代码源文件中的声明和文档注释进行语法分析,并在默认情况下生成一组HTML文档来描述类、内部类、接口、构造函数、方法和域。不过在运行过程中,它也使用了Java平台的环境变量...
类、类属性、类方法的注释必须使用javadoc规范,使用/**内容*/格式,不得使用//xxx方式和/*xxx*/方式。 说明:在IDE编辑窗口中,javadoc方式会提示相关注释,生成javadoc可以正确输出相应注释; 在IDE中,工程调用...
完整的Javadoc注释风格解释,其中包括包、类、方法、变量等的注释。结合相应的注释实例,配有显示后的效果图,最后使用Eclipse工具的export功能生成Javadoc。这样一个项目下来,大量详细的注释就直接生成一个好用的...
对于Java开发人员来说,在编写代码时,除了源程序以外,我们还会使用Javadoc标签对类、方法或成员变量进行注释,以便使用Javadoc工具生成和源代码配套的Javadoc文档。这些@param、@return等Javadoc标签是注解标签...
2.1. JavaDoc注释方法 6 2.2. 起始注释的记述方法 7 2.3. 其它注释的记述方法 7 3.缩进和空白 7 修订履历 2 目录 3 1.命名规范 4 1.1. 共通事項 4 1.2. 方法(函数)的命名 4 1.3. 字段与局部变量的命名 5 1.4. 命名...
我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。 文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注
这包括: 使用它们的接口 显示如何继承标签的类: 没有实现默认方法~> 该方法在类注释中没有文档块没有为其实现提供 Javadoc ~> 默认方法的文档被复制(并添加了注释)而没有新标签使用{@inheritDoc} ~> 继承没有新...
commons-collections4-4.1-javadoc 程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成...
类、类属性、类方法的注释必须使用...所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。 所有的类都必须添加创建者和创建日期。
本项目是IntelliJ IDEA的插件,能帮助java开发者自动生成javadoc文档注释。接入有道、百度、腾讯、阿里云等翻译,只要你方法名起的好,翻译就越准确。可自定义映射,弥补自动翻译的不足。支持文档翻译,选中需要翻译...
我们希望用这个工具注释的方法与用 javadoc 注释的方法是不相交的:javadoc 以公共 api 方法为目标,而我们以使用示例为目标,这些示例通常位于 src/test 和/或私有中。 安装 有两种安装方式: 集成到 gradle 脚本 ...
最后,如果您使用Javadoc和Swagger注释记录代码,则会有很多冗余数据。 因此,开发人员还有更多工作要做。 使用此Swagger生成工具,可以将Swagger信息放入Javadoc中,并使用此信息生成Swagger文档。 配置 将此插件...
赠送jar包:mybatis-3.4.2.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
赠送jar包:snakeyaml-1.19.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。
使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。
它了解Java文件中的标准Javadoc注释和Kotlin文件中的,并可以生成多种格式的文档,包括标准Javadoc,HTML和Markdown。 使用Dokka 完整文档可在 使用Gradle插件 注意:如果要从0.10.x升级到最新版本的Dokka,请查看...
语言使用单行注释块; 样式单行注释。 在注释行上按Shift+Enter以插入具有相同缩进级别的新注释行。 请参阅设置部分了解如何更改行为,以便Enter在Shift+Enter跳出注释块时插入注释行(这目前仅适用于部分语言)。 ...