每次创建文件的时候,自动加上作者、时间等信息是企业开发的第一步。

标准的 Javadoc 标签是什么

Java 官方支持的 Javadoc 标签包含(参见 Javadoc 官方文档):

标签用途
@author作者信息
@version版本号
@since从哪个版本开始引入
@param方法参数说明
@return方法返回值说明
@throws / @exception抛出异常说明
@see引用其他类或方法
@deprecated标记已过时
@serial / @serialData / @serialField用于序列化说明

不少人会把 JavaDoc 当成“写点说明文字”的地方,而不是“文档的一部分”。
导致写法随意,长短不一,缩进不统一、排版凌乱。

因为这部分不同团队、开源项目,没有任何统一的写法。所以,见仁见智,本篇文章,也会写出我个人认为OK的配置。

实战 - 添加File Header

配置如下:我这是中文插件,如果你是英文,直接搜索 File Templates

请依次找:Preferences - setting - 编辑器 -文件和代码模板 - Include

创建一个 File Header(如果有 直接在原有基础修改)里面填写如下代码:

/**
 * @author : zanglikun
 * @date   : ${DATE} ${TIME}
 * @version: 1.0
 * @desc   : 
*/

这样 就完事了。

上述文本如果装了Idea代码检查之类的插件,代码检查就会有黄色的提示,非常的难受,

你自己右键 快速修复

huimor使用下文内容

/**
 * Author: 最好用外国名,不然会有绿色的提示,不过绿色提示可忽略了
 * Date: ${DATE}
 * Time: ${TIME}
 * To change this template:Click IDEA-Preferences to search 'File Templates'
 */

京东使用

/**
 * @author  : zanglikun
 * @since   : ${DATE}
*/

高级用法 - 根据不同包路径实现不同File Header

#if ($PACKAGE_NAME && $PACKAGE_NAME.startsWith('com.xuelang'))
/**
 * @author : $USER
 * @date   : $DATE $TIME
 * @desc   : 
 */
#elseif ($PACKAGE_NAME && $PACKAGE_NAME.startsWith('com.ff11sf'))
/**
 * Project FFXI后台管理系统
 * @author : $USER
 * @date   : $DATE $TIME
 * @desc   : Copyright © zanglikun.com
 */
#else
/**
 * @author : $USER
 * @date   : $DATE $TIME
 * @desc   : Copyright © zanglikun.com
 */
#end

结论

结合实际项目的经验,我总结下不会导致Idea告警的配置如下:

#if ($PACKAGE_NAME && $PACKAGE_NAME.startsWith('com.xuelang'))
/**
 * 简要描述: 
 *
 * @author $USER
 * @since  $DATE $TIME
 */
#elseif ($PACKAGE_NAME && $PACKAGE_NAME.startsWith('com.ff11sf'))
/**
 * Copyright © zanglikun.com
 * 简要描述:
 *
 * @author $USER
 * @since  $DATE $TIME
 */
#else
/**
 * Copyright © zanglikun.com
 * 简要描述:
 *
 * @author $USER
 * @since  $DATE $TIME
 */
#end

特殊说明:
上述文章均是作者实际操作后产出。烦请各位,请勿直接盗用!转载记得标注原文链接:www.zanglikun.com
第三方平台不会及时更新本文最新内容。如果发现本文资料不全,可访问本人的Java博客搜索:标题关键字。以获取最新全部资料 ❤

免责声明:
本站文章旨在总结学习互联网技术过程中的经验与见解。任何人不得将其用于违法或违规活动!所有违规内容均由个人自行承担,与作者无关。