android开发编程规范,Android应用开发编程规范

整理下Android应用开发的编程范例

/**

* Java文件说明注释

*

* @version 0.1.0

* @author Fenng

* @date 2013/06/27

*/

package com.ici.example.codestyle; // 包名必须全为小写字母和数字, 不能有下划线

import android.util.Log; // import不要用'*'

import java.io.File;

import java.io.IOException;

/**

* 类说明注释

*

* 所有类成员变量声明放在类的开头, 在任何方法声明之前.

* 方法之间有一个空行

* 推荐使用英文进行注释

*/

public class CodeStyleExample { // 所有大括号起始都在行尾, 类名首字母大写

private static final String TAG = "examlpe.CodeStyleExample";

public static final int DATA_EXAMPLE = 0; // 常量全为大写字母, 以_分隔

public static final int DATA_EXAMPLE1 = 1;

public static final int DATA_EXAMPLE2 = 2;

public static final int DATA_EXAMPLE_ANOTHER = 3;

private static Object sLock = null; // 静态成员变量以s开头

private int mScreenOff = 0; // 非静态成员变量以m开头

/**

* 函数说明注释

*

* @param desc

* the function descriptions

* @return void

* 无

*/

public static void setFuncDescription(String[] desc) { // 函数名第一个字母小写, 其他首字母大写

int nState = 1; // 操作符必须前后都有空格, 所有;号之前都没有空格

// 缩进为4个space, 而不是tab

// 行注释或

/* 行注释 */

nState = -1; // 行尾注释

/*

* 多行注释

* 行2

*/

nState = nState + 1;

if (true || nState == 0) { // if语句, if语句一定要有大括号

nState = 1;

}

for (int i = 0; i < 10; i++) { //for语句, for语句一定要有大括号

nState++;

}

for (String string : args) { // foreach语句, 冒号两边各一个空格

//TODO::Fenng for shoud to set Log in DEBUG mode 2013/06/27

Log.i(TAG, string);

}

//Add::Fenng for try-catch 2013/06/27

try { // try语句, try与大括号之间一个空格

//TODO::Fenng for try do something 2013/06/27

} catch (Exceptiong e) { // catch紧跟在try的闭合大括号后, 并左右各一个空格

//TODO::Fenng for handle exception

Log.d(TAG, e.getMessage());

} finally { // finally与catch相同

return;

}

//AddEnd::Fenng 2013/06/27

switch (nState) {

case DATA_EXAMPLE:

Log.i(TAG, desc[0]);

break;

case DATA_EXAMPLE1:

case DATA_EXAMPLE2:

break;

default:

break;

}

while (true) {

//do something

break;

}

do {

// dummy

} while (true);

}

/**

* 类方法注释, 所以public的方法都要加注释

*

* @param param1

* 数据1

* @param param2

* 数据2

* @return String

* 返回测试数据

*/

public String run(int param1, int param2) {

return "example.CodeStyleExample.run";

}

}