疯狂java


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

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


 

        在TestJavadoc.java和Test.java所在路径执行上面命令,将可以看到生成API文档的提示信息。进入TestJavadoc.java和Test.java所在路径,将可以看到一个apidoc文件夹,该文件夹下就是刚刚生成的API文档,进入apidoc路径下,打开index.html文件,将看到如图3.5所示页面:

同样,如果单击图3.5所示页面的左下角类列表区的某个类,将可看到该类的详细说明,如图3.3和图3.4所示。(参见《Java文档注释(3)—[疯狂java讲义]》)

        除此之外,如果我们希望javadoc工具生成更详细的文档信息,例如为方法参数、方法返回值等生成详细的说明信息,则可利用javadoc标记,常用的javadoc标记有如下一些:

        1、@author:指定Java程序的作者。

        2、@version:指定源文件的版本。

        3、@deprecated:不推荐使用的方法。

        4、@param:方法的参数的说明信息。

        5、@return:方法的返回值的说明信息。

        6、@see:“参见”,用于指定交叉参考的内容。

        7、@exception:抛出异常的类型。

        8、@throws:抛出的异常,和exception同义。

        需要指出的是,这些标记的使用是有位置限制的。上面这些标记可以出现在类或者接口文档注释中的有@see、@deprecated、@author、 @version等;可以出现在方法或构造器文档注释中的有@see、@deprecated、@param、@return、@throws和@exception等;可以出现在属性文档注释中的有@see和@deprecated等。(未完.摘自[疯狂java讲义].李刚)