如何规范生成JAVADOC帮助文档

    javadoc使程序与文档密切结合起来,作为规范的开发步骤,程序的文档是可维护,可扩展的基础。当程序修改后,文档能相应改变,使文档与程序的一致性 非常好,JAVA编程要养成规范的程序注释。

       java的注释分成三种:单行注释(//)、多行注释(/*    */)、文本注释(/**              */)也叫归档注释。归档注释是一种专用注释;当它放在类或类成员声明之前时,javadoc工具可以提取出这些注释并用它们来生成程序的HTML文档。 归档注释通常入在类、接口、方法及字段定义之前。归档注释中可以使用几组特殊标记以提供更为特定的信息,这种注释从/**开始,至*/结束。在JAVA代 码开发过程中,形成规范文档是很重要的,要充分利用SUN公司提供的javadoc.exe这个命令。

       文本注释中的“文档标记”(Doc tags)是一些以“@”开头的命令,置于注释行的起始处(但前导的*会被忽略)。一个类和接口注释正好位于一个类和接口定义之前;而一个方法注释正好位 于一个方法定义的前面。变量注释正好位于变量定义之前。注意javadoc只能为public(公共)和protected(受保护)成员处理注释文档。 “private”(私有)和“友好”成员(即没有访问控制符)的注释会被忽略,我们看不到任何输出(也可以用-private标记包括private成 员)。这样做是有道理的,因为只有public和protected成员才可在文件之外使用,这是客户程序员的希望。然而,所有类注释都会包含到输出结果 里。 下面重点介绍类和方法的文档标记。

类文档标记
类文档可以包括用于版本信息以及作者姓名的标记。


格式如下:
@version 版本信息
其中,“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记,就会从生成的HTML文档里提取出版本信 息。

(2) @author
格式如下:
@author 作者信息
其中,“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javadoc命令行使用了“-author”标记,就会专门从生成的 HTML文档里提取出作者信息。
可为一系列作者使用多个这样的标记,但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。

方法文档标记
方法允许使用针对参数、返回值以及异常的文档标记。


格式如下:
@param 参数名 说明
其中,“参数名”是指参数列表内的标识符,而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记,就认为前一个说明结束。可使用任意数 量的说明,每个参数一个。


格式如下:
@return 说明
其中,“说明”是指返回值的含义。它可延续到后面的行内。


有关“违例”(Exception)的详细情况,我们会在第9章讲述。简言之,它们是一些特殊的对象,若某个方法失败,就可将它们“扔出”对象。调用一个 方法时,尽管只有一个违例对象出现,但一些特殊的方法也许能产生任意数量的、不同类型的违例。所有这些违例都需要说明。所以,违例标记的格式如下:
@exception 完整类名 说明
其中,“完整类名”明确指定了一个违例类的名字,它是在其他某个地方定义好的。而“说明”(同样可以延续到下面的行)告诉我们为什么这种特殊类型的违例会 在方法调用中出现。

(4) @deprecated
这是Java 1.1的新特性。该标记用于指出一些旧功能已由改进过的新功能取代。该标记的作用是建议用户不必再使用一种特定的功能,因为未来改版时可能摒弃这一功能。 若将一个方法标记为@deprecated,则使用该方法时会收到编译器的警告。

       顺便提一下在eclipse下,当鼠标处于类,方法定义行时,按Alt+Shift+J,就可以快速添加文档注释。至于如何导出javadoc文 档,eclipse环境下,file > export > javadoc > 这里只要选中你要导出的*.java文件即可,要十分注意的是,通常很多人的classpath环境下,带有 %classpath% 这使javadoc命令无法正确地执行。而提示的出错信息通常是IlleagalArgumentException。

常用tag标签有@author @return @param@throws @see @version @since @link @deprecated

你可能感兴趣的:(javadoc)