您的位置:首页 > 移动开发 > Android开发

Android的注释规范

2015-06-06 21:36 381 查看
对一个有经验的开发人员来说,代码风格可以体现一个程序员的功底。在这里,注释可以体现出来。下面直接上代码。

1.对文件的注释

/**
* @文件名 MainActivity
* @描述  主活动
* @作者 Allen
* @时间 2015/6/6
* @版本 1.0
*/
public class MainActivity extends Activity {

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

}

}



2.对函数的注释

/**
* @方法名 onClick(View v)
* @功能 MainActivity控件点击事件
* @参数 View v
* @返回值 无
*/
public void onClick(View v){

}



3.对变量的注释

private String deviceID;  //设备的ID(唯一标识)
private String devicemodel; //设备型号
private String devicename; //设备名称(例如:热水器)
private boolean devicestate; //设备状态(在线或离线)


4.对代码块的注释

<span style="white-space:pre">		</span><pre name="code" class="java">//遍历每个成员变量,打印每个成员变量
for(int i = 0;i < list.size();i++){
System.out.println(list.get(i).getName());
}



                                            
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: