Android Studio 中两种方式定制自己的代码注释头

时间:2024-03-30 19:45:21

在使用Android Studio的时候,每当新创建一个Java文件的时候,系统会自动帮我们生成一个文件注释头,类似

/***

*Create By SomeOne  On 2017/03/30 

**/

这样的文件头注释风格,可能有的人觉得这太普通,而且信息量太少了,有没有办法展示更多的信息量呢,比如包名类名,公司或者组织信息等?毫无疑问,肯定是有办法来满足各位看官的,下面我这个菜鸟带大家来实践一下。


第一种情况:直接修改File Header来实现(系统默认会加载这里的内容)

修改File Header可以实现定制自己的文件注释头,因为系统会默认加载这里的文件,下面看下具体的操作步骤和实现效果

Android Studio 中两种方式定制自己的代码注释头

右侧绿色字体的就是我们自己编写的注释模板了,可以看到我给每个Java文件增加了包名,类名创建时间和作者,以及邮箱和组织机构等标签,你们也可以自己创建更多的标签(前面可以不用@符号),后面的美元符号跟的是对包名类型的引用,具体可以参照描述框的描述

Android Studio 中两种方式定制自己的代码注释头

修改好了之后记得Apply,并选择OK保存

下面看下具体的效果

Android Studio 中两种方式定制自己的代码注释头

新建一个Java类,你会发现神奇的事情发生了

Android Studio 中两种方式定制自己的代码注释头

你可以看到,Java文件的头部注释变成了我们定义的模板,包含类名,包名,创建时间,作者,Email和组织名称,请原谅我打了那么多的马赛克Android Studio 中两种方式定制自己的代码注释头Android Studio 中两种方式定制自己的代码注释头Android Studio 中两种方式定制自己的代码注释头,不过效果是杠杠滴,可以看到包名和类名,以及日期时间都被替换成了当前文件的信息,这就是引用的魅力,哈哈Android Studio 中两种方式定制自己的代码注释头,不小心暴露的时间,是的愚人节后的一天,大好的清明假期,阳光明媚,而作为单身狗的我还在公司无聊的写博文。Android Studio 中两种方式定制自己的代码注释头


第二种情况:定制动态Templates(推荐使用)

第一种情况虽然达到了我们想要的效果,但是不通用,某种情况下:比如你定制了含有组织机构和公司信息的File Header的时候,每当创建一个Java文件的时候系统都会帮你自动的生成这些模板文件,某些情况下你并不需要这些信息,比如你自己写的Demo并不想打上公司的标签,其实这个时候你可以手动删除有关公司信息的那一条,其实也不难,直接鼠标定位到那一行,然后快捷键 Ctrl + Y (删除行),这样使用也没问题,但是有一天你接了另一个公司的项目,而且需要你把代码打上另一个公司的标签,难道你要一行一行的删除然后在每个文件中逐条添加信息吗?肯定不会,如果偷懒的程序员肯定会想着回去改下File Header 文件的模板,这个是可以的,那如果下次又有这样的情况发生呢?是不是要疯了Android Studio 中两种方式定制自己的代码注释头 , 那有没有更好的解决办法呢?我认为是可以解决这些冲突的,就是要灵活的运用Templates

下面看下具体的操作步骤:

Android Studio 中两种方式定制自己的代码注释头

回到Java文件中,输入headFile(自定义的提示输入文本)

Android Studio 中两种方式定制自己的代码注释头

看下效果,两个都能生成类似的注释头,下面你可以哪里不要删哪里Android Studio 中两种方式定制自己的代码注释头,如果有更多的公司,你需要定制更多的动态面板文件模板,可以分别取名head_01 head_02 …… head_n 等等

Android Studio 中两种方式定制自己的代码注释头


好了,演示效果到此结束,谢谢大家捧场,我得去吃点东西了,注意运行环境是Android Studio。


版权声明:本文为博主原创文章,未经博主允许不得转载。