Java笔记06

Java

1、文档注释/** … */，用于生成HTML文档
① 类注释，在import语句之后，类定义之前
/**
 * A <code> Card </code> object represents a playing card.
 * such as …
 */
public class Card {
    …
}

Note: 
♥ 文档注释中间的“*”并非必要
♥ 可使用HTML修饰符，但切不要使用<h1>或<hr>

② 方法注释：必须放在所描述方法之前，除了通用标记，还可使用以下标记
@param变量描述：对当前方法的“param”参数部分添加一个条目，此描述可占据多行可用HTNL标记。一个方法的所有@param标记必须放在一起
@return描述：对当前方法添加返回部分注释
@throws类描述：添加一个用于表示这个方法有可能抛出的异常的注释

③ 域注释：只需对公有域（通常指静态常量）建立文档
④ 通用注释：
    @author  姓名
    @version  版本信息
    @since文本  e.g. @since version 1.1.1
    @deprecated文本  对类、方法、变量添加一个不=不再使用的注释。文本中给出取代的建议 e.g. @deprecated Use <code>setVisible </code> instead!
    @see/@link 引用  用于使用超链接  e.g. 
♥ package.class#feature lebel   //一定要用“#”而非“.”
♥ <a href="…">label</a>
♥ "text"

2、注释抽取：形成一份专业的注释文档
javadoc -d docDirectory nameOfPackage(1、2、3……)
默认包注释抽取：javadoc -d docDirectory *.java