注释方式的选择

注释方式的选择

作为编程小白最近在帮导师做一个小的安卓项目，做的时候借鉴了网上一些大神的代码，发现代码的注释非常的“好看”。在写本篇博客之前，我写注释无非就是//或是ctrl+shift+/。下面我会推荐两种注释的方式：

1. 在每个方法的上方写注释采用/**+enter的方式，会自动地生成方法中每个参数以及return，每个参数的注释可自行编辑。
   .
2. Android Studio 中配置自动生成文件的头注释：
   配置路径：Files–>Settings–>File and Code Templates–>Includes
   修改File Header即可：

/**
* 在此写用途
* @FileName:
*          ${PACKAGE_NAME}.${NAME}.java
* @author: myName
* @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @version V1.0 <描述当前版本功能>
*/

myName 填写自己的姓名
日期，文件名都会自动生成
这样创建java文件时就自动添加头部文件