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

一家之言,供大家参考。

 

目录
相关文章
clion中cpp文件显示This file does not belong to any project ,code insight features might not work【解决方案】
clion中cpp文件显示This file does not belong to any project ,code insight features might not work【解决方案】
clion中cpp文件显示This file does not belong to any project ,code insight features might not work【解决方案】
|
8月前
|
数据管理 中间件 数据库
settings.py文件
【2月更文挑战第11天】settings.py文件。
55 1
Get Files In Folder [ DTFolderFiles ] 插件说明
Get Files In Folder [ DTFolderFiles ] 插件说明
86 0
Get Files In Folder [ DTFolderFiles ] 插件说明
|
Java Android开发
eclipse project修改 output folder
eclipse project修改 output folder
149 0
Cypress系列(100)- cypress-file-upload 插件, attachFile() 命令详解
Cypress系列(100)- cypress-file-upload 插件, attachFile() 命令详解
412 0
Cypress系列(100)- cypress-file-upload 插件, attachFile() 命令详解
|
Java
【错误记录】IntelliJ IDEA 中 Java 代码中的中文注释报错 ( Menu / File / Settings / Editor / File Encodings 中修改工程编码 )
【错误记录】IntelliJ IDEA 中 Java 代码中的中文注释报错 ( Menu / File / Settings / Editor / File Encodings 中修改工程编码 )
886 0
【错误记录】IntelliJ IDEA 中 Java 代码中的中文注释报错 ( Menu / File / Settings / Editor / File Encodings 中修改工程编码 )
AndroidStudio笔记(4)编码效率+1 的 File Templates
前言 这一篇是接着 AndroidStudio笔记(3)的,在上一篇中我们使用了 Live Templates的关键字来快速补全和生成代码,那有没有更近一步的骚操作?比如创建文件?答案是肯定的,那就是 File Templates。
1106 0
|
JavaScript PHP 前端开发
PHPStorm File and Code Template
有时候我们想新建某类型文件的时候,默认出现一些基础代码,而不是空白的。 比如当新建一个 html 文件 基础代码是这样的: 同理,当新建php文件,我希望是这样:
1411 0
|
索引 图形学 测试技术
Resources文件夹解析
翻译自官网文档:https://unity3d.com/cn/learn/tutorials/topics/best-practices/resources-folder 2.1。
991 0
studio设置File Templates
从项目的整体风格考虑,对所有类要进行必要的说明,就注释说明来说首先需要说明是作者,文件创建时间,业务功能说明,这几项是基本的内容,而添加这些说明内容以前可能手动的添加文件标题头,这种做法现在都非常过时了。
998 0