android studio中如何设置注释模板---项目开发规范

来源:互联网 发布:telnet登录端口 编辑:程序博客网 时间:2024/05/16 18:57

前言

大型项目开发中,规范的统一注释格式是团队开发的前提,尽量保证各自代码自己维护。这样既能保证代码编写者在逻辑上的一惯性,也能避免修改不熟悉的代码而引起bug问题,但即使是这样的规避,也依然无法避免程序员之间代码的混合。所以,针对在一个类中,产出几个人同时需要添注的代码。最好能做代码注释的区分。这样为长时间后的代码维护,起到必要的指引作用,同时也能也方便快速检索


费话不多说了,快速的在代码中,添加自定义注释呢?在此就给各位道明。


方法:

1.打开 File->Setting


2.打开 Editor->Live Templates


3.创建Template Group


4.填写group名称。


5.在author组下,创业Live template


填写abbreviation(得取个方便输入,自己能一看就懂的了)。填写template text,设置change,编辑edit variables。最后apply。

说明:$date$ $time$(是自定义的,按格式抒写) 需要编辑edit variables才可使用编辑template text(编写好后,打开edit variables,自动出现自定义的name)。


6.设置在java代码中输入iauthor,显示注释内容。



完成!

在代码中,输入iauthor,自动生成注释:



补充:

使用as建类的时候,是不是都会自动出现这段注释?


如果需要修改,去file and code temlates修改file header!



自定义注释讲解完成。实用起来吧!

原创粉丝点击