Idea 设置模板
类注释：
模板内容：
/**
* @Author: 张运行
* @Email: zyhhy137@163.com
* @Create: $date$ $time$
* @Description: ${DESCRIPTION}
*/
变量：
方法注释模板内容
/**
* @Author:{作者名称}
* @Create: $date$ $time$
* @Description :{方法职责描述} $param$ $return$ $throws$
*/
变量
Param：groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ' {参数描述信息}' + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
Return：groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\" + ' {返回结果说明}'", methodReturnType())
Throws：
groovyScript("def result = '';def exceptions = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(int i = 0; i < exceptions.size(); i++) { if(exceptions[i] != null) { result += '* @throws ' + exceptions[i] + ' {什么条件下会抛这个异常}' + ((i < exceptions.size() - 1) ? '\\r\\n ' : '') } }; return result == '' ? null : '\\r\\n ' + result", methodThrows())
注意：因idea版本问题，有些不支持methodThrows ()函数，@throws可能无法完美生成，若方法没有抛异常自动生成的@throws注释自己删除。或者谁有好的脚本或者插件集思广益一下。
使用方式：必须在类或者方法的上一行 输入cc加回车，要不然无法正确生成对应的格式。
-----------------------以下摘至烟草要求文档，各位阅读一下，开发中请注意满足要求
6.6.1 Java代码注释
(1)【强制】类、类属性、类方法的注释必须使用Javadoc规范，使用/**内容*/格式，不
得使用//xxx方式。
说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注
释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读
效率。
(2)【强制】所有的抽象方法(包括接口中的方法)必须要用Javadoc 注释、除了返回值、参
数。
异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
(3)【强制】所有的类都必须添加创建者和创建日期。
(4)【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行
注释，使用/**/注释，注意与代码对齐。
(5)【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
(6)【推荐】用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
反例：“TCP连接超时”解释成“传输控制协议连接超时”分反而难以理解。
(7)【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核
心逻辑等的修改。
(8)【参考】合理处理注释掉的代码。在上方详细说明，而不是简单的注释掉。如果无用，
则删除。说明：代码被注释掉有两种可能性：1)后续会恢复此段代码逻辑。2)永久不用。前者如果
没有备注信息，难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。
(9)【参考】对于注释的要求：第一能够准确反应设计思想和代码逻辑；第二、能够描述业
务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者难
以理解，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，
使其能够快速接替自己的工作。
(10)【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现
注释过多极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
(11)【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标
记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
a)待办事宜(TODO):(标记人，标记时间，[预计处理时间])表示需要实现，但目前还未实现的功
能。这实际上是一个Javadoc的标签，目前的Javadoc还没有实现，但已经被广泛使用。只能应
用于类，接口和方法(因为它是一个Javadoc标签)。
b)错误，不能工作(FIXME):(标记人，标记时间，[预计处理时间])
在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。
示例说明：
Copyright必须放在文件顶部，为固定值，如下。
/**
*Copyright(C)xxxx xxxx xxx
194
*Al1 rights reserved.
*<p>
*版权所有(C)XXXXXXXXX
*/
类/接口/枚举注释必须包含 作者、邮箱、创建时间、类职责描述。如下
/**
*@Author :{作者名称}
* @Email:{作者工作邮箱}
* @Create:{年}/{月}/{日}{24小时制时间}
* @Description:{类职责描述}
*/
方法注释必须包含 作者、邮箱、创建时间、描述、参数、返回值。如下
/**
* @Author:{作者名称}
* @Create:{年}/{月}/{日}{24小时制时间}
* @Description :{方法职责描述}
* @param request{参数含义)
* @return CloudPlatformInfo{返回值含义人
* @throws Exception{什么条件下会抛这个异常}
*/
TODO、FIXME 注释必须包含时间，作者、提示内容。如下
// TODO:{年}/{月}/{日}24小时制时间}by {作者名称},{提示内容}
// FIXME:{年}/{月/铂}{24小时制时间}by {作者名称},{提示内容}
例子
/**
* Copyright/(C)xxxx xxxx xxx
*A11rights reserved.
米<p
*版权所有(C)XXXXXXXXX
*/
package com.tobacco.xxx;
import com.tobacco.xxx;
/**
195
* @Author :Xxxx Zzz
* @Email:name@abc.com
*@Create:2021/11/19 11:36
* @Description :示例接口
*/
public interface Clazz {
/**
* @Author Xxxx Zzz
*@Create:2021/11/19 11:36
* @Description:获取指定信息
*@param request 请求参数
*@return PlatformInfo 平台信息
*@throws ApiException 服务api异常
*/
PlatformInfo getPlatformInfo(Request request)throws ApiException;
// TODO 2021/11/24 15:35 by xxxx,此处Request需要重构
}
