在做项目案例的时候通常会用到注释,但是很多程序员不知道怎么正确的注释,正确的注释才能有效的生成doc项目结构文档。

 

一、配置位置

Window->Preference->Java->Code Style->Code Template->Comments

二、基本配置

类型(Types)注释标签(类的注释)

/**
 * 
 * </br>博客:http://www.shijiayi.top
 * @ClassName: ${type_name}
 * @Description: 功能描述:()
 * @author 成都训码科技有限公司 - 石嘉懿
 * @date ${date} ${time}
 * ${tags}
*/

方法 (Methods) 标签:

/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}方法描述:()
 * @param ${tags}    设定文件
 * @return ${return_type}    返回类型
 * @throws
 * </br>博客: http://www.shijiayi.top
 * </br>方法描述:
 * 
 * </br>版本记录:
 *
*/

 

备注:

在注释中可以使用</br>等标签,快捷生成注释方法是shift+alt+j

最后修改于 2020-04-20 10:55:06
如果觉得我的文章对你有用,请随意赞赏
扫一扫支付
上一篇