idea上关于类、接口、方法的默认注释

idea上关于类、接口、方法的默认注释

类的注释

在settings的File and Code Templates中找到class。在右边输入注释格式。

变量使用${}的形式。

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * @ClassName ${NAME}
 * @Description 添加描述
 * @Author Waynejwei
 * @LastChangeDate ${DATE} ${TIME}
 * @Version v1.0
 */
 
public class ${NAME} {
}

添加以后每次创建类便会默认显示注释。

接口注释

同样在settings的File and Code Templates中找到interface。

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * @InterfaceName ${NAME}
 * @Description 添加描述
 * @Author Waynejwei
 * @LastChangeDate ${DATE} ${TIME}
 * @Version v1.0
 */

public interface ${NAME} {
}

方法注释

在settings的LiveTemplates中点击+号，添加注释

/**
 * @MethodName $methodName$
 * @Param $param$
 * @Description 添加描述
 * @Return $return$
 * @LastChangeDate $LastChangeDate$
 * @Version v1.0
 */

此时获取方法中的内容使用$name$。