Android注释技巧

1.如何快速生成文档注释

光标定位到要注释的类、属性或者函数上，然后右键 -> Source -> Generate Element Comment，我更喜欢用快捷键 Alt + Shift + J，就能自动生成注释了。

2. 文档注释中字段的含义（重点）

@author 作者信息
@param 参数信息
@return 返回信息
@exception 异常信息
@throws 抛出异常信息 （@exception 和 @throws 经测试效果是一样的）
@category 分类信息
@since 自哪个版本开始
@see 有的函数需要借助其他类或者函数或者属性，就用该标签标识。 
@see #本类函数名/属性名 可以查看其他函数或属性
@see 包名.类名 可以查看其他类 
@deprecated 表示该函数不建议使用了，在这个标签里写上为什么不建议使用以及提供替换该方法的新方法。加上这个标签后，注释显示里不会提示，但是函数名会被画一道删除线 
{@link #函数名/属性名} 链接本类属性/函数
{@link 包名.类名} 链接其他类 
当希望注释换行时，可以在新一行注释前加上<p>（如果不加，就算换行了，鼠标放在函数上显示的也是没有换行，类似html）

3. 如何修改注释模板

使用方法：打开Eclipse -> Window -> Preferences -> Java -> Code Style

1.点击Code Templates -> Import … “MyCodetemplates.xml”

2.点击Formatter -> Import …”MyFormatter.xml”