疯狂java


您现在的位置: 疯狂软件 >> 新闻资讯 >> 正文

Java文档注释(8)—[疯狂java讲义]


 

        下面TestJavadocTag程序包含了一个hello方法,该方法的文档注释使用了@param和@return等文档标记。
程序清单:codes33-1TestJavadocTag.java
Package yeeku;
/**
* Description
* <br/>Copyright (C),2005-2008,Yeeku.H.Lee
*<br/>This program is protected by copyright laws.
*<br/>Program Name:
*<br/>Date:
*@author Yeeku.H.Lee kongyeeku@163.com
*@version 1.0
*/
Public class TesJavadocTag
{
/**
 *一个得到打招呼字符串的方法。
 *@param name 该参数指定向谁打招呼。
 *@return 返回打招呼的字符串。
 */
Private String hello(String name)
{
Return name +”,你好!”;
}
}
        上面程序中粗体字标识出使用javadoc标记的示范。再次使用javadoc工具来生成API文档,这次为了能提取到文档中的@author和@version等标记信息,在使用javadoc工具时增加-author和-version两个选项,即按如下格式来使用运行javadoc命令:
Javadoc –d apidoc –windowtitle 测试 –dcotitle 学习 javadoc 工具的测试API文档 –header 自定义类 –version –author Test*.java
        上面命令将会提取Java源程序中的-author和-ersion两个标记的信息,除此之外,还会提取@param和@return标记的信息,因而将会看到如图3.6所示API文档页面:
        注意:javadoc工具默认不会提取@author和@version两个标记的信息,如果需要提取这两个标记的信息,应该在使用javadoc工具时指定-author和-version两个选项。
        对比图3.2(见《Java文档注释(2)—[疯狂java讲义]》)和图3.5(见《Java文档注释(7)—[疯狂java讲义]》),两个图都显示了API文档的首页,但图3.2显示的API文档首页里包含了对每个包的详细说明,而图3.5的文档首页里每个包说明部分都是空白,这是因为API文档中的包注释并不是直接放在Java源文件中的,而是必须另外指定,通常通过一个标准的HTML文件来提供包注释,这个文件被称为包描述文件,包描述文件的文件名通常是package.html,并与该包下所有Java源文件放在一起,javadoc工具会自动寻找对应的包描述文件,并提取该包描述文件中的<BODY/>元素里的内容,作为该包的描述信息。(未完.摘自[疯狂java讲义].李刚)