三. 使用 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
可以自己看看这两种方法的区别
到此为止
javadoc
就简单介绍完了,想要用好她还是要多用,多参考标准
java
代码
(可参考JDK安装目录下的src源文件包)
java javadoc 注释模板 javadoc注释方法
转载本文章为转载内容,我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题,欢迎原作者联系我们进行内容更正或删除文章。
下一篇:emWin学习 emwin开发
提问和评论都可以,用心的回复会被更多人看到
评论
发布评论
相关文章
-
javadoc 注释源码 javadoc注释方法
最近听到很多做程序员的小伙伴儿吐槽:从别人那儿接手的代码总是乱糟糟的,完全不知道写的什么!没有标记,没有说明,也没有一行注释,抓耳挠腮也看不懂! 前程序员辞职留下的代码,谁也不愿意接手这个时候,就需要万能的“注释”大大了!所谓注释,便是用自然语言对源代码中某些语句或方法进行说明。并且,注释的内容不会被编译器编译。你可以在源代码中添加任何你想要添加的说明,随便多少都可以,只要你不觉得啰嗦
javadoc 注释源码 javadoc注释 java文档注释不显示 java文档注释看不到 为什么开源的代码没有注释