Android代码规范

10. 其他资源命名

遵循见名知意的原则，组成名称的单词必须全部小写，单词之间用下划线隔开。

欢迎

#FFFFFF

注释

养成良好的注释习惯，对提升自己的编程能力和团队合作能力有很大的益处。

1. 文件注释

源文件的开头需要注释说明当前的文件信息，包括文件名、作者、版本信息、日期、修改记录等。

/*

* -----------------------------------------------------------------

* Copyright (C) 2007-2014, by HuaShengRun, Shenzhen, All rights reserved.

* -----------------------------------------------------------------

*

* File: RequestManager.java

* Author: JiongBull

* Version: 1.0

* Create: 2014-8-10

*

* Changes (from 2014-8-10)

* -----------------------------------------------------------------

* 2014-8-10 : 创建 RequestManager.java (JiongBull);

* -----------------------------------------------------------------

*/

2. 类注释

在类的开头添加类信息的描述.

/**

* 管理Volley的Request, 使用之前需要调用init()进行初始化.

*/

public class RequestManager {

}

3. 方法注释

一般情况下需要为每个方法添加注释，包括方法的功能描述，参数信息、返回值、异常信息等，有些约定俗成的方法可以不需要添加注释，请参考约定俗成的说明。

/**

* 输出日志.

*

* @param context Context

* @param logLevel 日志等级

* @param tag 标签

* @param content 输出内容

* @param throwable 异常信息, 若没有异常可为空

*/

private static void trace(final Context context, final int logLevel, final String tag, final String content, final Throwable throwable) {

...

}

4. 域变量和常量注释

/**

* 日志的扩展名.

*/

public static final String LOG_EXTENSION = .log;

/**

* 网络请求队列.

*/

private RequestQueue mRequestQueue;

5. 其他注释

单行注释

view.setImageResource(defaultImageResId); // 无图片显示默认图片

区块注释

/* 网络图片添加渐变动画 */

Resources resource = mContext.getResources();

final TransitionDrawable transitionDrawable =

new TransitionDrawable(new Drawable[] {

new ColorDrawable(android.R.color.transparent),

new BitmapDrawable(resource, bmpResponse)

});

view.setBackgroundResource(defaultImageResId);

view.setImageDrawable(transitionDrawable);

transitionDrawable.startTransition(RequestManager.FADE_IN_TIME);

6. XML注释

约定俗成

1. get / set 方法的注释

通过IDE工具批量生成域变量的 get / set 方法可以不用注释。

2. 第三方库生成代码的注释

第三方库生成的代码可以不用注释，例如greenDao生成的代码。

3. 通用类的注释

通用类的公共方法应全部添加注释。

4. 一般情况下的注释

例如在activity、service等文件中，只需对关键的类变量进行注释，方法建议全部添加注释。