javadoc生成注释(2)Java认证考试

文章作者 100test 发表时间 2010:04:23 22:30:58
来源 100Test.Com百考试题网

　　3 注释块标记
　　3.1 标记的顺序
　　块标记将采用如下顺序：
　　1.…
　　2.
　　3.*
　　4.
　　5.* @param (classes, interfaces, methods and constructors only)
　　6.
　　7.* @return (methods only)
　　8.
　　9.* @exception (@throws is a synonym added in Javadoc 1.2)
　　10.
　　11.* @author (classes and interfaces only, required)
　　12.
　　13.* @version (classes and interfaces only, required. See footnote 1)
　　14.
　　15.* @see
　　16.
　　17.* @since
　　18.
　　19.* @serial (or @serialField or @serialData)
　　20.
　　21.* @deprecated (see How and When To Deprecate APIs)
　　22.
　　23.* …
　　24.
　　一个块标记可以根据需要重复出现多次，多次出现的标记按照如下顺序：
　　1.@author 按照时间先后顺序（chronological）
　　2.
　　3.@param 按照参数定义顺序（declaration）
　　4.
　　5.@throws 按照异常名字的字母顺序（alphabetically）
　　6.
　　7.@see 按照如下顺序：
　　8.
　　9.@see #field
　　10.
　　11.@see #Constructor(Type, Type...)
　　12.
　　13.@see #Constructor(Type id, Type id...)
　　14.
　　15.@see #method(Type, Type,...)
　　16.
　　17.@see #method(Type id, Type, id...)
　　18.
　　19.@see Class
　　20.
　　21.@see Class#field
　　22.
　　23.@see Class#Constructor(Type, Type...)
　　24.
　　25.@see Class#Constructor(Type id, Type id)
　　26.
　　27.@see Class#method(Type, Type,...)
　　28.
　　29.@see Class#method(Type id, Type id,...)
　　30.
　　31.@see package.Class
　　32.
　　33.@see package.Class#field
　　34.
　　35.@see package.Class#Constructor(Type, Type...)
　　36.
　　37.@see package.Class#Constructor(Type id, Type id)
　　38.
　　39.@see package.Class#method(Type, Type,...)
　　40.
　　41.@see package.Class#method(Type id, Type, id)
　　42.
　　43.@see package
　　44.
　　3.2 标记介绍
　　3.2.1 @param标记

　　编辑特别推荐:

　　javadoc生成注释(2)