Android常用注释标签

Bolg - 常用注释标签

创建文件注释模版

Preferences -- Editor -- File and Code Templates -- Includes

img.png

模版代码：

/**
 * 全路径：${PACKAGE_NAME}
 * 类描述：
 * 创建人：${USER}   
 * 创建时间：${DATE} ${TIME} 
 */

常用代码注释

@link

用途：可以直接跳转到指定类、方法、变量，并且IDE可以在修改类名时自行更换注释。

使用：

    //内部类
    /**
     * {@link TargetClazz.InnerClazz}
     */

    //方法
    /**
     * {@link TargetClazz#say()}
     */

    //变量
    /**
     * {@link TargetClazz#key}
     */

@param

用途：说明参数用途或意义。

使用：

    /**
     * @param key key的注释
     */
    public void methodA(int key) {

    }

@deprecated

用途：标注已废弃，使用时会有代码提示。

使用：

    /**
     * @deprecated 已废弃，建议使用{@link #methodA(int)}
     */
    public void methodB(String key) {

    }

@throws

用途：说明方法可能会抛出的异常。

使用：

    /**
     * @throws IllegalArgumentException 校验key值不能>0
     */
    public void methodC(int key) {
        if (key > 0) {
            throw new IllegalArgumentException("key不能大于0");
        }
    }