代码规范（四）

5.2.3.1 若指向类、方法或变量名
可在@see后直接写上类、方法或变量名，书写方法时可省略包、类名，特性会默认为当前包或类。注意：类、方法、变量名间使用“#”分隔。如：

1 /**
2    ...
3 @see packeg.class#readInt(String)
4 */

5.2.3.2 若指向一个具体的URL，则直接书写HTML标签锚。如：

1 /**
2    ...
3 @see <a href=”www.java.com”>The Java Site</a>
4 （HTML标签的书写，参见关于HTML的书籍）
5 */

5.2.3.3 若指向到“seealso（参考）”小节显示出来，使用“”””（双引号）。如：

1 /**
2     ...
3     @see “java1.2 volume2”
4     注：可书写多个标记，但必须放在一起，以下全部一样。
5 */

5.2.4 @link
@link：可在注释中建立特殊的超链接，令其指向其他类或方法，标记规则同@see。

5.3 类和接口注释说明
类注释必须置于任何一个import语句后面，同时位于class定义的前面。

@author 名字：建立一个“作者”条目。

@version 文字：建立一个“版本”条目。

5.4 方法注释说明
紧靠在每条方法的前面，必须有一个它所描述的那个方法的签名。

@param 变量描述：给“parameters”（参数）小节增添一个条目。
@return 描述：增添一个“returns”（返回值）小节。
@throws 类描述：为方法的“throws”（产生违例）小节增添一个条目。
如：

1 /**
2 将一个双精度数格式化成一个字串
3 @param x 要格式化的数字
4 @return 格式化成的字串
5 @throws 如参数错误，产生IllegalArgumentException（非法参数违例）
6 */.