javadoc 命令对注释规范的详细介绍与模板的生成

《javadoc 命令对注释规范的详细介绍与模板的生成》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、1.注释规范由于生成的文档是html款式，而这些html款式的标识符并非javadoc加的，而是程序员在写注释的时候加上去的。如：需要换行时，不是敲回车符，而是写入
,要是要分段，就该当在段前写入

.2.javadoc记号由“@”及其后所跟的记号类型和专用注释引用组成。javadoc记号有如下这些：@author对类的阐明说明该类模板的作者@version对类的阐明说明该类模板的版本@see对类、属性、方式的阐明参照的转向@param对方法的阐明，列举方法中的参数@return对方式的阐明，

2、方法中的返回值@exception对方法的阐明，列举方法中可能抛出的异常3.下面介绍各javadoc记号的运用注意项：1、@see的句法有3种：1).@see类名2).@see#方法名或属性名3).@see类名#方法名或属性名（注：如果是属性名，则只需要写出属性名即可；如果是方法名，则需要写出方法名以及参数类型，没有参数的方式，需要写出一对括号）第2个句法中没有指出类名，则默以为目前类。因此它定义的参照，全转向本类中的属性或者方式。而第3个句法中指出了类名，则不错转向其它类的属性或者方式。2、@par

3、am、@return、@exception句法每一个@param只能描写方式的1个参数，因此，要是方式需要不止一个参数，就需要不止一次运用@param来描写。一个方法中只能有1个@return,可以抛出多个异常,需要不止一个@exception来描述。4.设置java代码注释的模板设置注释模板的入口：Window->Preference->Java->CodeStyle->CodeTemplate然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：文件(Files)注释标签

4、：/***@Title:${file_name}*@package${package_name}*@Description:${todo}*@authorwuqiong*@date${date}${time}*@version*/类型(Types)注释标签（类的注释）：/***

Title:${type_name}

Description:${todo}

5、**@Fields${field}*/方法(Constructor&Methods)标签：/***@Title:${enclosing_type}*@Description:${todo}*${tags}${return_type}*@throws*/覆盖方法(OverridingMethods)标签：/*(non-Javadoc)*

Title:${enclosing_method}

Description:

6、方法(DelegateMethods)标签：/***${tags}*${see_to_target}*/模板设计好之后，有两种方法使用：1.输入/**回车；2.shift+alt+J5.模板快速输入alt+/补全增加自己的快捷提示，可以修改现有的