Android编码规范

转载请说明出处 http://blog.csdn.net/lyfaxt/article/details/51422982

目的与概述

本文提供一整套编写高效可靠的android代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，你作为一个 Java 或者android 软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。
通用命名约定

注释风格


➢ 方法注释。方法注释主要对一个方法的主要功能，返回值，异常信息进行描述。一个可用的模版如下
/**
* @Description: ${todo} * @param * @return${return_type}
* @throws
*/
➢ 字段注释。变量注释主要对变量的作用进行描述。可以使用单行注释。
➢ 其他注释。其他注释包括复杂业务逻辑的注释，for/while循环控制结构的注释等其他任何通过注释可以增加代码可读性的地方。

开发规范

比如一些控件命名，具体我贴项目中的代码可以参考一下
TextView ：tv_+描述 Button ：btn_+描述
ImageButton ：imgBtn_+描述 ImageView ：image_+描述
CheckBox ：cb_+描述 RadioButton ：rb_+描述
AnalogClock ：alg_+描述 DigitalClock ：dtc_+描述
Activity就要以Activity结尾，对应xml要以activity_开头
Fragment就要以XXXFragment,对应xml要以fragment_xxx结尾



对应的资源图片要有规范话，每个模块对应一组图片资源

适配器Adapter我这里用的是item开头

总之每个人风格不同，终归得有一套属于自定的开发规范
先写注释再写代码
写代码注释的最好方法是在写代码之前就写注释。这使你在写代码之前可以想想代码的功能和运行。而且这样确保不会遗漏注释。另一种方法是边写代码边写注释。因为注释可以使代码更易理解，所以在程序开发的过程中，也可以利用这一点。如果打算花些时间写注释，那么至少你应从这个过程中获得些什么
良好的编码规范可以让我们快速定位错误，让我们的心情更加愉悦，特别是对于处女座的人来说。