Android常用常见的注释语法
@link语法
适合在你的注释中引用任意一个类、字段或者方法
代码语言：javascript复制/**
* 这里要引用一个类 {@link package.MyClass} <br/>
* 这里要引用一个类里面的子类 {@link package.MyClass.SubClass}<br/>
* 这里要引用一个类里面的方法 {@link package.MyClass#method(Context, Object)} // 注意这里()里面的是方法的参数类型，使用不同的参数签名可以来区别不同的重载方法 <br/>
* 这里要引用一个类李曼的字段 {@link package.MyClass#field} // 这里不区分字段是否是public 或者 static，都可以直接引用 <br/>
* 这里要引用改类本身的方法或者字段 {@link #method(Context, Object)}和{@link #field}
*/@linkplain语法
功能同@link语法，不过可以给显示指定一个别名
代码语言：javascript复制/**
* 这里要引用一个类 {@linkplain package.MyClass 别名} <br/>
*/@param语法
适合给方法的参数写说明
代码语言：javascript复制/**
* 这是方法的说明
* @param param1 这里是参数1的说明
* @param param2 这是是参数2的说明
*/
void method(int 参数1, int 参数2) { }@see语法
在注释的末尾添加，适合说明需要参考的地方，一般作为补充说明用
代码语言：javascript复制/**
* 这是方法的说明
*
* @param 参数1 这里是参数1的说明
* @param 参数2 这是是参数2的说明
*
* @see #method()
* @see #method(int)
*/
void method(int 参数1, int 参数2) {
}
void method() {
}
void method(int 参数1) {
}@deprecated语法
用于表示该方法已废弃
代码语言：javascript复制 /**
* @deprecated 已废弃，建议使用{@link #method(int)} (int)}
*/
void method() {
}@exception语法
适合用于说明可能抛出的异常类型，以及在什么情况下抛出异常
代码语言：javascript复制 /**
* 这是方法说明
* @param age
* @exception IllegalArgumentException 校验参数有问题将抛出，如age < 0
*/
void method(int age) {
if (age < 0) {
throw new IllegalArgumentException("age must >= 0!!!");
}
// TODO ...
}语法"><pre class="prettyprint">语法
适合在你的注释中放上一段高亮的代码
代码语言：javascript复制/**
* 以下是本类方法的执行顺序
* <pre class="prettyprint">
* public class Activity extends ApplicationContext {
* protected void onCreate(Bundle savedInstanceState);
*
* protected void onStart();
*
* protected void onRestart();
*
* protected void onResume();
*
* protected void onPause();
*
* protected void onStop();
*
* protected void onDestroy();
* }
* </pre>
*/语法
用于注释的换行<br /> 在敲注释的时候可能你会碰到用enter键换行无效的情况，这个时候用 在行的尾部就行了
代码语言：javascript复制/**
* 第一行<br />
* 第二行<br />
* 最后一行
*/<a/>语法
除了HTML本身支持链接到一个特定URL，也能起到跟<@link>语法一样的引用作用
代码语言：javascript复制/**
* <ul>
* <li><a href="#FROM_WHERE_SHOW_TEAM">可以参考这个字段</a></li>
* <li><a href="package.MyClass">参考这个类</a></li>
* </ul>
*/<h/>语法
用于给注释加小标题
代码语言：javascript复制/**
* <h3>Class Info</h3>
* 我是Class Info内容
* <h3>Usages</h3>
* 我是Usages内容
* <h3>Help</h3>
* 我是Help内容
*/
