Android中的注释以及修改注释模板的方法

1、常见的注释方法

@author 

作者信息

@link

在注释中使用，可以快速定位一个类、子类、类中的方法或者类中的字段，Ctrl+左键，就可以快速跳转到链接的类或方法

/**
 * 这里要引用一个类 {@link package.MyClass} <br/>
 * 这里要引用一个类里面的子类 {@link package.MyClass.SubClass}<br/>
 * 这里要引用一个类里面的方法 {@link package.MyClass#method(Context, Object)} // 注意这里()里面的是方法的参数类型，使用不同的参数签名可以来区别不同的重载方法 <br/>
 * 这里要引用一个类里面的字段 {@link package.MyClass#field} // 这里不区分字段是否是public 或者 static，都可以直接引用 <br/>
 */

@linkplain

同link，但是这里可以给类起一个别名

/**
 * 这里要引用一个类 {@linkplain package.MyClass 别名} <br/>
 */

@param

方法参数说明

/**
 * @param param1 这里是参数1的说明
 * @param param2 这是是参数2的说明
 */
void method(int 参数1, int 参数2) { }

@see

一般在注释尾部，用于添加一些可以参考的地方，比如该方法可以参考其他的相关的什么方法

/**
     *
     * @param 参数1 这里是参数1的说明
     * @param 参数2 这是是参数2的说明
     *            
     * @see #method()
     * @see #method(int)
     */
    void method(int 参数1, int 参数2) {

    }

    void method() {
    }

    void method(int 参数1) {
    }

@deprecated

标记方法已废弃，可以用@link标记新的替换方法

@exception

用于说明方法会抛出什么样的异常，什么情况下回抛出异常

@return 

返回信息

@throws 

抛出异常信息 （@exception 和 @throws 经测试效果是一样的）

@category

 分类信息

@since

 自哪个版本开始

 

2、自定义注释模板

步骤：

基本的需求，可以根据自己的需求随意修改

/**
 * @Name：${PROJECT_NAME}
 * @Description：描述信息
 * @Author：${USER}   
 * @Date：${DATE} ${TIME} 
 * 修改人：${USER}  
 * 修改时间：${DATE} ${TIME}  
 * 修改备注：  
 * @version
 */