在我们开发过程中,为了让项目便于二次开发,在我们编写一个类或者方法时需要有详细的注释,让接手的开发人员可以轻松的看懂你写的代码。
下面介绍在Android studio和eclipse中添加代码注释的功能,包括显示作者名、项目名、创建时间、功能描述等.....
1、在Android studio中
Settings-->File and Code Templates-->Includes -->apply-->ok
这样设置后,在你新建一个类的时候,就会显示如下效果:
/**
* 项目名称:${PROJECT_NAME}
* 类描述:
* 创建人:${USER}
* 创建时间:${DATE}${TIME}
* 修改人:
* 修改时间:
* 修改备注:
*/
2、在eclipse中
Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit-->OK-->apply
在edit窗口中复制下面代码,也可根据个人喜好进行修改,最后点击ok-->apply,记住记得点击apply,不然看不到效果。
建一个类,鼠标点在类名(或者方法名)处,按添加注释的快捷键ALT+shift+J
/**
* 项目名称:${project_name}
* 类名称:${type_name}
* 类描述:
* 创建人:@author Ivone
* 创建时间:${date}${time}
* 修改人:
* 修改时间:
* 修改备注:
*/