Waif工作室Android开发代码规范.docVIP

WAIF工作室Android开发规范 2013-11-07 1.命名基本原则 在面向对象编程中，对于类，对象，方法，变量等方面的命名应该本着描述性以及唯一标识性这两大特征来命名，才能保证资源之间不冲突，并且每一个都便于记忆。 命名原则是：使名称足够长以便有一定的意义，并且足够短以避免冗长。 2.命名基本规范 2.1.编程基本命名规范 （1）避免难懂的名称，如属性名xxK8，这样的名称会导致多义性。 ? （2） 在面向对象的语言中，在类属性的名称中包含类名是多余的，如Book.BookTitle，而是应该使用Book.Title。 ? （3）在允许函数重载的语言中，所有重载都应该执行相似的函数。 （4）使用动词-名词的方法来命名对给定对象执行特定操作的例程，如CalculateInvoiceTotal()。（例程是某个系统对外提供的功能接口或服务的集合） ? （5）只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。 （6）在变量名中使用互补对，如min/max、begin/end和open/close。 ? （7）布尔变量名应该包含Is，这意味着Yes/No?或 True/False 值，如 fileIsFound。 ? （8）即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名 称。仅对于短循环索引使用单字母变量名，如 i 或 j。 （9）为了帮助区分变量和例程，对例程名称使用Pascal大小写处理 (CalculateInvoiceTotal)，其中每个单词的第一个字母都是大写的。对于变量名，使用 camel大小写处理 (documentFormatType)，其中除了第一个单词外每个单词的第一个字母都是大写的。 （10）不要使用原义数字或原义字符串，而是使用命名常数，NUM_DAYS_IN_WEEK ，以便于维护和理解。 2.2.分类命名规范 （1）包的命名 　 　　Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在必威体育精装版的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 　　例如： net.frontfree.javagroup （2）类的命名 　　 类的名字必须由大写字母开头而单词中的其他字母均为小写；如果类名称由多个单词组成，则每个单词的首字母均应为大写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。 　　 　　例如： Circle （3）方法的命名 　　方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。 　　例如： sendMessge （4）.常量的命名 　　常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。 　　例如： 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，这些段落将在生成文档中以特定方式显示。 虽然为一个设计低劣的程序添加注释不