知识大全 javadoc生成注释(2)

Posted 2022-07-19 知

篇首语：一名具有高尚师德的教师，须是一个因材施教，公正公平对待每一名学生的教师。本文由小常识网(cha138.com)小编为大家整理，主要介绍了知识大全 javadoc生成注释(2)相关的知识，希望对你有一定的参考价值。

　　注释块标记　　标记的顺序　　块标记将采用如下顺序　　 …　　　　 *　　　　 * @param (classes interfaces methods and constructors only)　　　　 * @return (methods only)　　　　 * @exception (@throws is a synonym added in Javadoc )　　　　 * @author (classes and interfaces only required)　　　　 * @version (classes and interfaces only required See footnote )　　　　 * @see　　　　 * @since　　　　 * @serial (or @serialField or @serialData)　　　　 * @deprecated (see How and When To Deprecate APIs)　　　　 * …　　　　一个块标记可以根据需要重复出现多次多次出现的标记按照如下顺序　　 @author 按照时间先后顺序（chronological）　　　　 @param 按照参数定义顺序（declaration）　　　　 @throws 按照异常名字的字母顺序（alphabetically）　　　　 @see 按照如下顺序　　　　 @see #field　　　　 @see #Constructor(Type Type )　　　　 @see #Constructor(Type id Type id )　　　　 @see #method(Type Type )　　　　 @see #method(Type id Type id )　　　　 @see Class　　　　 @see Class#field　　　　 @see Class#Constructor(Type Type )　　　　 @see Class#Constructor(Type id Type id)　　　　 @see Class#method(Type Type )　　　　 @see Class#method(Type id Type id )　　　　 @see package Class　　　　 @see package Class#field　　　　 @see package Class#Constructor(Type Type )　　　　 @see package Class#Constructor(Type id Type id)　　　　 @see package Class#method(Type Type )　　　　 @see package Class#method(Type id Type id)　　　　 @see package　　　　标记介绍　　 @param标记　　@param后面空格后跟着参数的变量名字（不是类型）空格后跟着对该参数的描述　　在描述中第一个名字为该变量的数据类型表示数据类型的名次前面可以有一个冠词如 a an the 如果是int类型的参数则不需要注明数据类型例如　　 …　　　　 * @param ch the char 用用来……　　　　 * @param _image the image 用来……　　　　 * @param _num 一个数字……　　　　 …　　对于参数的描述如果只是一短语最好不要首字母大写结尾也不要句号　　对于参数的描述是一个句子最好不要首字母大写如果出现了句号这说明你的描述不止一句话如果非要首字母大写的话必须用句号来结束句子（英文的句号）　　公司内部添加ByRef和ByVal两个标记例如　　 * @param _image the image ByRef 用来……　　说明该参数是引用传递（指针） ByVal可以省略表示是值传递　　 @return标记　　返回为空（void）的构造函数或者函数 @return可以省略　　如果返回值就是输入参数必须用与输入参数的@param相同的描述信息　　必要的时候注明特殊条件写的返回值　　 @throws 标记　　@throws以前使用的是@exception 　　@throws的内容必须在函数的throws部分定义　　 @author标记　　类注释标记　　函数注释里面可以不出现@author 　　 @version　　类注释标记　　函数注释里面可以不出现@version　　 @since　　类注释标记　　标明该类可以运行的JDK版本　　例如　　 @since JDK 　　 @deprecated　　由于某种原因而被宣布将要被废弃的方法　　 /**　　　　 * @deprecated As of JDK replaced by　　　　 * setBounds　　　　 * @see #setBounds(int int int int)　　　　 */　　　　 @link标记　　语法 @link <mailto:% B@link> package class#member label　　Label为链接文字　　package class#member将被自动转换成指向package class的member文件的URL 　　 HTML代码的使用　　在注释描述部分可以使用HTML代码　　…　　表示段落　　* … 　　表示自动标号　　注释示例　　 /**　　　　 * Graphics is the abstract base class for all graphics contexts　　　　 * which allow an application to draw onto ponents realized on　　　　 * various devices or onto off screen images 　　　　 * A Graphics object encapsulates the state information needed　　　　 * for the various rendering operations that Java supports This　　　　 * state information includes:　　　　 *　　　　 # * The Component to draw on　　　　 # * A translation origin for rendering and clipping coordinates　　　　 # * The current clip　　　　 # * The current color　　　　 # * The current font　　　　 # * The current logical pixel operation function (XOR or Paint)　　　　 # * The current XOR alternation color　　　　 * (see setXORMode)　　　　 *　　　　 *

cha138/Article/program/Java/hx/201311/26801