您的位置:首页 > 编程语言 > Java开发

Java 注释模板设置 -- 个人总结

2017-05-06 21:41 281 查看
选择了另一个 Offer 之后,项目经理第一次看我费了九牛二虎之力完成的第一个任务。

(SpringMVC + MyBstis + FreeMarker + 日志 + 权限认证)

第一次使用 FreeMarker ,开始搭建框架、开始脱离一部分网络进行开发 …

被 骂的一塌糊涂,注释、注释、注释!太简单、太简单、太简单!

心里有几万只草泥马在奔腾 。。。

博文仅对开发过程中使用的模板进行汇总,以便后续形成规范化,希望有用。

--------------------------------------
1. Files Comments Tags:
--------------------------------------

/**
* @Title: ${file_name}
*
* @Package ${package_name}
*
* @Description: ${todo}
*
* @author kngines
*
* @date ${date}
*
* @version V1.0
*/


--------------------------------------
2. Types Comments Tags:
--------------------------------------

/**
* @ClassName: ${type_name}
*
* @Description: ${todo}
*
* @author kngines
*
* @date ${date}
* ${tags}
*/


--------------------------------------
3. Fields Comments Tags:
--------------------------------------

/**
* Title:
* 
* Description:
*/


--------------------------------------
4. Constructors Comments Tags:
--------------------------------------

/**
* @Title: $${enclosing_method}
*
* @Description: ${todo}
*
* @param ${tags}
*
* @return ${enclosing_type}
*
* @throws
*/


--------------------------------------
5. Methods Comments Tags:
--------------------------------------

/**
* @Title: $${enclosing_method}
*
* @Description: ${todo}
*
* @param ${tags}
*
* @return ${enclosing_type}
*
* @throws
*/


--------------------------------------
6. Overriding Methods Comments Tags:
--------------------------------------

/*
* Title: ${enclosing_method}
*
* Description: </p>
*
* ${see_to_overridden}
* ${tags}
*/


--------------------------------------
7. Delegate Methods Comments Tags:
--------------------------------------

/**
* ${tags}
*
* ${see_to_target}
*/


博文后续会更新,后续会总结 个性化eclipse、Myeclipse、IntelliJ IDEA,形成文件,从而省去多次配置的麻烦。
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  注释 java