Android Studio注释详解

一、注释的作用

代码注释是提供代码文档信息的重要方法，包括可以帮助开发人员更容易地理解代码、让代码变得更易于维护和更容易与他人共享。Android Studio在注释方面提供了丰富的功能，包括：

1、为类、方法、字段等提供全文描述

/**
 * MainActivity是应用的主界面
 * 界面包含一个TextView和一个Button
 */
public class MainActivity extends AppCompatActivity {
    private TextView tv_content;
    private Button btn_change;
    ...
}

2、为参数、返回值等提供描述

/**
 * 点击按钮改变文本显示
 * @param view 视图
 */
public void changeContent(View view) {
    tv_content.setText("你好，世界！");
}

3、为代码提供代码范例和说明

//启动另一个Activity并传递参数
Intent intent = new Intent(this, SecondActivity.class);
intent.putExtra("key", value);
startActivity(intent);

4、为TODO、FIXME等标注提供支持

//TODO: 完善错误处理逻辑
if (data != null) {
    ...
} else {
    //FIXME: 处理data为null的情况
    Log.e(TAG, "data is null");
}

二、注释的类型

Android Studio提供了多种注释类型，包括：

1、块注释

/*
 * 这是一个多行注释
 * 注释内容可以跨越多行
 */

2、行注释

// 这是一个单行注释

3、文档注释

/**
 * 这是一个文档注释
 * 可以包含HTML标签和注释标记
 *
 * @param param 参数
 * @return 返回值
 * @throws Exception 异常说明
 */
public String doSomething(String param) throws Exception {
    ...
}

三、注释的格式

注释的格式是约定成俗的，在团队开发中必须统一遵守，包括：

1、注释前空格

//正确的注释格式
int a = 1; //注释
//错误的注释格式
int b = 2;//注释

2、注释分行

//正确的注释格式
int c = 3;
//注释
int d = 4;
//错误的注释格式
int e = 5;//注释
int f = 6;//注释

3、注释符号

//使用//进行单行注释
/*使用/* */进行多行注释*/
/**使用/** */进行文档注释*/

4、文档注释标记

/**
 * 这是一个文档注释
 *
 * @param param 参数
 * @return 返回值
 * @throws Exception 异常说明
 */

四、注释的示例

下面是一个关于Android Studio注释的完整示例：

/**
 * MainActivity是应用的主界面
 * 界面包含一个TextView和一个Button
 *
 * TODO: 完善错误处理逻辑
 * FIXME: 处理data为null的情况
 */
public class MainActivity extends AppCompatActivity {
    private TextView tv_content;
    private Button btn_change;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        tv_content = (TextView) findViewById(R.id.tv_content);
        btn_change = (Button) findViewById(R.id.btn_change);

        //单行注释
        //为按钮设置点击事件
        btn_change.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                changeContent(v);
            }
        });
    }

    /**
     * 点击按钮改变文本显示
     * @param view 视图
     */
    public void changeContent(View view) {
        tv_content.setText("你好，世界！");
    }
}