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   
 * 
 */

一家之言，供大家参考。

 

转载于:https://www.cnblogs.com/xilinch/p/8529559.html