JBuilder2005创建开发文档之标签介绍 - 编程入门网

作者佚名技术来源 NET编程浏览发布时间 2012-06-24

下：

图 8 getSex()方法的详细说明

通过这个实例的描述，我们对Javadoc的标签和编写有了大致的了解。注释一般置于须注释元素的前面，如类的注释位于public class Xxx类声明代码的前面，而值域的注释位于public int xxx前面。为了编写优美的Javadoc文档，你不但需要掌握简单的HTML编写知识，更需要了解Javadoc标签的知识。

不同版本的JDK所支持的Javadoc标签是不一样的，此外还可以按标签适用的地方分成不同类型，如只适用于方法的@return标签，我们称之为方法标签，只适用于变量的@serial标签，我们称之为值域标签，以此类推。往往一个标签适用于多种地方，下表对常用Javadoc标签进行说明：

表 2?1 javadoc标签说明

标签	说明	JDK 1.1 doclet	标准doclet	标签类型
@author 作者	作者标识	√	√	包、类、接口
@version 版本号	版本号	√	√	包、类、接口
@param 参数名描述	方法的入参名及描述信息，如入参有特别要求，可在此注释。	√	√	构造函数、方法
@return 描述	对函数返回值的注释	√	√	方法
@deprecated 过期文本	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。	√	√	包、类、接口、值域、构造函数、方法
@throws异常类名	构造函数或方法所会抛出的异常。		√	构造函数、方法
@exception 异常类名	同@throws。	√	√	构造函数、方法
@see 引用	查看相关内容，如类、方法、变量等。	√	√	包、类、接口、值域、构造函数、方法
@since 描述文本	API在什么程序的什么版本后开发支持。	√	√	包、类、接口、值域、构造函数、方法
{@link包.类#成员标签}	链接到某个特定的成员对应的文档中。		√	包、类、接口、值域、构造函数、方法
{@value}	当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。		√(JDK1.4)	静态值域

JBuilder2005创建开发文档之标签介绍(4)

时间:2010-03-27 陈雄华

此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签，由于不常使用，我们展开叙述，感兴趣的读者可以通过http://www.java.sun.com/J2SE/javadoc查看它们详细的帮助信息。

下面我们对表中所列的几个不容易理解的Javadoc标签举例说明。

* @see

可以通过这个标签在当前点链接到某个类、值域或方法的说明上。为了链接到当前类的

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!

分享到：更多

你可能对下面的文章感兴趣

上一篇: JBuilder 2005 Struts深度体验之改造 - 编程入门网下一篇: Java连接各种数据库的实例 - 编程入门网

关于JBuilder2005创建开发文档之标签介绍 - 编程入门网的所有评论

随机推荐