studio设置File Templates

简介: 从项目的整体风格考虑,对所有类要进行必要的说明,就注释说明来说首先需要说明是作者,文件创建时间,业务功能说明,这几项是基本的内容,而添加这些说明内容以前可能手动的添加文件标题头,这种做法现在都非常过时了。

从项目的整体风格考虑,对所有类要进行必要的说明,就注释说明来说首先需要说明是作者,文件创建时间,业务功能说明,这几项是基本的内容,而添加这些说明内容以前可能手动的添加文件标题头,这种做法现在都非常过时了。

通过studio可以配置有关的file header达到自动添加的目的。

配置的方式如下图

配置代码如下:

/**
 * Created by ${USER} on ${DATE} ${TIME}.
 * describe 该类主要完成以下功能
 *  1.主要功能   
 */

下面讨论下这个类还可能需要那些说明。

首先应该有版本变迁说明,每个版本发生了那些变动,增、改、删了那些业务功能,并对这些修改内容进行必要的描述。

其次应该有修订人说明,以及修订人联系方式,方便日后沟通。

因此,综上所述,file header设置为下面。

/**
 * Created by ${USER} on ${DATE} ${TIME}.
 * describe 该类主要完成以下功能
 * 1.主要功能   
 * change info: v1.0 创建
 *               v1.1 增加直播功能                    
 * modify by tony    tony@126.com   
 * 
 */

一家之言,供大家参考。

 

目录
相关文章
|
4月前
|
数据管理 中间件 数据库
settings.py文件
【2月更文挑战第11天】settings.py文件。
33 1
Get Files In Folder [ DTFolderFiles ] 插件说明
Get Files In Folder [ DTFolderFiles ] 插件说明
63 0
Get Files In Folder [ DTFolderFiles ] 插件说明
|
Java 数据库 Android开发
|
Java Android开发
eclipse project修改 output folder
eclipse project修改 output folder
117 0
|
JavaScript Java
|
iOS开发
Xcode 10: third-party: 'config.h' file not found
升级xcode到10版本之后 遇到 config.h 文件找不到的问题 In the Terminal, navigate to the react-native/third-party/glog folder inside node_modules...
1569 0
studio设置File Templates
从项目的整体风格考虑,对所有类要进行必要的说明,就注释说明来说首先需要说明是作者,文件创建时间,业务功能说明,这几项是基本的内容,而添加这些说明内容以前可能手动的添加文件标题头,这种做法现在都非常过时了。
975 0
|
Android开发 C++
Android Studio Linking an external C++ project 时候 报Invalid file name. Expected: CMakeLists.txt
Android Studio 右键Linking an external C++ project 时候 报Invalid file name. Expected: CMakeLists.txt错误   查看Android Studio 源码: @Nullable private Stri...
1234 0
|
iOS开发
Xcode Source Editor Extension
在 Xcode 8.0 的 beta 里面,Apple 引入了一个新的面向 macOS 的 App Extension,叫做 Xcode Source Editor Extension(以下简称插件),今天看到一个提问说是这个怎么弄,我简单看了一下 WWDC 的 Session:https://developer.apple.com/videos/play/wwdc2016/414/ 现在总结在这
3789 0