Android开发代码规范..docVIP

Android开发代码规范  1.命名基本原则 在面向对象编程中，对于类，对象，方法，变量等方面的命名是非常有技巧的。比如，大小写的区分，使用不同字母开头等等。但究其本，追其源，在为一个资源其名称的时候，应该本着描述性以及唯一性这两大特征来命名，才能保证资源之间不冲突，并且每一个都便于记忆。 对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。命名原则是：使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。以下几点是的命名方法。 .命名基本规范 2.1.编程基本命名规范 （1）避免难懂的名称，如属性名xxK8这样的名称会导致多义性。 ?  在面向对象的语言中，在类属性的名称中包含类名是多余的，如Book.BookTitle而是应该使用Book.Title。 ? 在允许函数重载的语言中，所有重载都应该执行相似的函数。 使用动词-名词的方法来命名对给定对象执行特定操作的例程，如CalculateInvoiceTotal()。 ? （5）只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。 在变量名中使用互补对，如min/max、begin/end和open/close。 ? 布尔变量名应该包含Is，这意味着Yes/No?或 True/False 值，如 fileIsFound。 ? .常量的命名 　　常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。 　　例如： MAX_VALUE （5）参数的命名 　　参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。 （6）Javadoc注释 　　Java除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，它是用来记录我们代码中的API的。Javadoc注释是一种多行注释，以/**开头，而以*/结束，注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。 　　例如： /** * This is an example of * Javadoc * * @author darchon * @version 0.1, 10/11/2002 */ 　　在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这些段落将在生成文档中以特定方式显示。 虽然为一个设计低劣的程序添加注释不会使其变成好的程序，但是如果按照编程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完美，运行效率高且易于理解的程序，尤其是在多人合作完成同一项目时编程规范就变得更加重要。俗话说“磨刀不误砍柴工”，花费一点时间去适应一下Java编程规范是有好处的。 3.分类命名规范 3.1.基本数据类型命名规范 Integer：int+描述 Char：chr+描述 Boolean：bln+描述 Long：lng+描述 Short：shr +描述 Double：dbl+描述 String：str+描述 Float：flt+描述 Single：sng+描述 DataTime：dt+描述 Array：arr+描述 Object：obj+描述 如：String srtName; 3.2.控件命名规范 TextView?：txt_+描述 Button?：btn_+描述 ImageButton?：imgBtn_+描述 ImageView?：imgView_+描述 CheckBox?：chk_+描述 RadioButton?：rdoBtn_+描述 AnalogClock?：anaClk_+描述 DigitalClock?：DgtClk_+描述 DatePicker?：dtPk_+描述 TimePicker?：tmPk _+描述 ToggleButton?：tglBtn_+描述