代码注释风格指南：简约VS官方
本文介绍了两种代码注释风格：简约Style和官方Style。简约风格简洁明了，适合快速记录创建者和时间；官方风格更为正式，包含作者、日期、时间和版本信息。你可以根据个人或团队偏好选择合适的注释方式。
本文提供两种注释风格供参考。
风格1：简约Style
效果如下：
设置步骤：
File--> Settings--> Editor--> File and Code Templates--> Includes--> File Header--> "添加以下代码"
添加如下代码（此处的${USER}会读取个人PC的用户名）：
/**
* Created by ${USER} on ${DATE} ${TIME}
*/
如果想指定作者名称（比如：Miracle Luna），可以用以下代码：
/**
* Created by Miracle Luna on ${DATE} ${TIME}
*/
此时效果如下：
风格2：官方Style
效果如下：
设置步骤：
File--> Settings--> Editor--> File and Code Templates--> Includes--> File Header--> "添加以下代码"
添加如下代码（此处的${USER}会读取个人PC的用户名）：
/**
* @Author ${USER}
* @Date ${DATE} ${TIME}
* @Version 1.0
*/
如果想指定作者名称（比如：Miracle Luna），可以用以下代码：
/**
* @Author Miracle Luna
* @Date ${DATE} ${TIME}
* @Version 1.0
*/
此时效果如下：
扫一扫
886
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
