Idea代码注释模板

这篇文章记录一下自己常用的代码注释模板以便翻阅

类注释

/**   
 * TODO
 * Created on $date$ $time$
 * @author $author$
 * @version V1.0   
*/

其中$$符号中间的函数参见idean中的内置函数

方法注释

/**  
 * TODO
 * Created on $date$ $time$
 *@author: $author$   
 *@param: $param$
 *@return: $return$ 
 *@throws:
 */

在使用mvn javadoc:javadoc生成文档的时候如果注释写的不规范，那么将会报错，这里贴一些我在纠正自己的时候犯的错误

• >、<这种xml需要转义的字符不要出现在注释中，要不然会报错，因为javadoc最后是要输出html文件的，而注释中是支持<p><b>这种html标签的，所以会报错