Android编码规范Word格式.docx

1、方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。 public void run（）; public String getBookName（）;类中常用方法的命名：1. 类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如getFirstName（），getLastName（）。一般来说，get前缀方法返回的是单个值，find前缀的方法返回的是列表值。2. 类的设置方法（一般返回类型为void）：被访问字段名的前面加上前缀 set，如setFirstName（）,setLastName（）.3. 类的布尔型的判断方法一般要求方法名使用单词

2、 is或has 做前缀，如isPersistent（），isString（）。或者使用具有逻辑意义的单词，例如equal 或equals。4. 类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile（），addCount（）。5. 构造方法应该用递增的方式写。（参数多的写在后面）。6. toString（）方法：一般情况下，每个类都应该定义toString（）,其格式为：5. 变量命名第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，

3、能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为 i，j，k，m 和 n，它们一般用于整型；c，d，e，它们一般用于字符型。String bookName;变量命名也必须使用驼峰规则，但是首字母必须小写，变量名尽可能的使用名词或名词词组。同样要求简单易懂，不允许出现无意义的单词。 正确String bookNameString; 错误！6. 成员变量命名同变量命名，但不要在私有变量前添加m字样！7. 常量命名类常量的声明，应该全部大写，单词间用下划线隔开。static final int MIN_WIDTH = 4;static final int MAX

4、_WIDTH = 999;static final int GET_THE_CPU = 1;8. 异常命名自定义异常的命名必须以Exception为结尾。已明确标示为一个异常。9. layout 命名layout xml 的命名必须以 全部单词小写，单词间以下划线分割，并且使用名词或名词词组，即使用 模块名_功能名称 来命名。knowledge_gained_main.xml正确list_book.xml错误！10. id 命名layout 中所使用的id必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，并且要求能够通过id直接理解当前组件要实现的功能。某TextView +id

5、/textbookname 错误 !应为 +id/book_name_show某EditText +id/textbookname 错误 !应为 +id/book_name_edit11. 资源命名layout中所使用的所有资源（如drawable,style等）命名必须以全部单词小写，单词间以下划线分割，并且尽可能的使用名词或名词组，即使用 模块名_用途 来命名。如果为公共资源，如分割线等，则直接用用途来命名menu_icon_navigate.png 正确某分割线：line.png 或 separator.png 正确注释Java 程序有两类注释：实现注释（implementation c

6、omments）和文档注释（document comments）。实现注释是使用/*.*/和/界定的注释。文档注释（被称为doc comments）由/*.*/界定。文档注释可以通过javadoc 工具转换成HTML 文件。12. 文件注释所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。如下： /* * 文件名 * 包含类名列表 * 版本信息，版本号 * 创建日期。 * 版权声明 */13. 类注释每一个类都要包含如下格式的注释，以说明当前类的功能等。/* * 类名 * author 作者 * 实现的主要功能。 * 创建日期* 修改者，修改日期，修改内容。*/14.

7、 方法注释每一个方法都要包含 如下格式的注释 包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。 * * 方法的一句话概述 * 方法详述（简单方法可不必详述） * param s 说明参数含义 * return 说明返回值含义 * throws IOException 说明发生此异常的条件 * throws NullPointerException 说明发生此异常的条件15. 类成员变量和常量注释成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义* XXXX含义16. 其他注释方法内部的注释 如果需要多行 使用/* */形式，如果为单行是用

8、/形式的注释。不要再方法内部使用 java doc 形式的注释“/*/”，简单的区分方法是，java doc形式的注释在 eclipse中为蓝色，普通注释为绿色。17. XML注释如果当前layout 或资源需要被多处调用，或为公共使用的layout（若list_item），则需要在xml写明注释。要求注释清晰易懂。代码风格18. 缩进不允许使用Tab进行缩进，使用空格进行缩进，推荐缩进为2空格。19. 空行空行将逻辑相关的代码段分隔开，以提高可读性。 下列情况应该总是使用空行： 一个源文件的两个片段（section）之间 类声明和接口声明之间 两个方法之间 方法内的局部变量和方法的第一条语句

9、之间 一个方法内的两个逻辑段之间，用以提高可读性 通常在 变量声明区域之后要用空行分隔，常量声明区域之后要有空行 分隔，方法声明之前要有空行分隔。20. 行宽无特别规定，因为现在的显示器都比较大，所以推荐使用120进行设置。规约21. 方法 一个方法尽量不要超过15行，如果方法太长，说明当前方法业务逻辑已经非常复杂，那么就需要进行方法拆分，保证每个方法只作一件事。 不要使用 try catch 处理业务逻辑！22. 参数和返回值 一个方法的参数尽可能的不要超过4个！ 如果一个方法返回的是一个错误码，请使用异常！ 尽可能不要使用null， 替代为异常 或者使用空变量 如返回 List 则可以使用

10、Collections.emptyList（）23. 神秘的数代码中不允许出现单独的数字，字符！如果需要使用数字或字符，则将它们按照含义封装为静态常量！（for语句中除外）24. 控制语句判断中如有常量，则应将常量置于判断式的右侧。if （ true = isAdmin（）.尽量不使用三目条件的嵌套。所有if 语句必须用包括起来,即便是只有一句：if （true）/do something.if （true）i = 0; /不要使用这种 对于循环： /不推荐方式_while（index = 0） ? -x21种代码的坏味道应该在编程中尽量避免这21种“坏味道”。31. Duplicated C

11、ode代码重复几乎是最常见的异味了。他也是Refactoring 的主要目标之一。代码重复往往来自于copy-and-paste 的编程风格。32. Long method它是传统结构化的“遗毒“。一个方法应当具有自我独立的意图，不要把几个意图放在一起。33. Large Class大类就是你把太多的责任交给了一个类。这里的规则是One Class One Responsibility。34. Divergent Change一个类里面的内容变化率不同。某些状态一个小时变一次，某些则几个月一年才变一次；某些状态因为这方面的原因发生变化，而另一些则因为其他方面的原因变一次。面向对象的抽象就是把相

12、对不变的和相对变化相隔离。把问题变化的一方面和另一方面相隔离。这使得这些相对不变的可以重用。问题变化的每个方面都可以单独重用。这种相异变化的共存使得重用非常困难。35. Shotgun Surgery这正好和上面相反。对系统一个地方的改变涉及到其他许多地方的相关改变。这些变化率和变化内容相似的状态和行为通常应当放在同一个类中。36. Feature Envy对象的目的就是封装状态以及与这些状态紧密相关的行为。如果一个类的方法频繁用get 方法存取其他类的状态进行计算，那么你要考虑把行为移到涉及状态数目最多的那个类。37. Data Clumps某些数据通常像孩子一样成群玩耍：一起出现在很多类的

13、成员变量中，一起出现在许多方法的参数中.，这些数据或许应该自己独立形成对象。38. Primitive Obsession面向对象的新手通常习惯使用几个原始类型的数据来表示一个概念。譬如对于范围，他们会使用两个数字。对于Money，他们会用一个浮点数来表示。因为你没有使用对象来表达问题中存在的概念，这使得代码变的难以理解，解决问题的难度大大增加。好的习惯是扩充语言所能提供原始类型，用小对象来表示范围、金额、转化率、邮政编码等等。39. Switch Statement基于常量的开关语句是OO 的大敌，你应当把他变为子类、state 或strategy。40. Parallel Inherita

14、nce Hierarchies并行的继承层次是shotgun surgery 的特殊情况。因为当你改变一个层次中的某一个类时，你必须同时改变另外一个层次的并行子类。41. Lazy Class一个干活不多的类。类的维护需要额外的开销，如果一个类承担了太少的责任，应当消除它。42. Speculative Generality一个类实现了从未用到的功能和通用性。通常这样的类或方法唯一的用户是testcase。不要犹豫，删除它。43. Temporary Field一个对象的属性可能只在某些情况下才有意义。这样的代码将难以理解。专门建立一个对象来持有这样的孤儿属性，把只和他相关的行为移到该类。最常

15、见的是一个特定的算法需要某些只有该算法才有用的变量。44. Message Chain消息链发生于当一个客户向一个对象要求另一个对象，然后客户又向这另一对象要求另一个对象，再向这另一个对象要求另一个对象，如此如此。这时，你需要隐藏分派。45. Middle Man对象的基本特性之一就是封装，而你经常会通过分派去实现封装。但是这一步不能走得太远，如果你发现一个类接口的一大半方法都在做分派，你可能需要移去这个中间人。46. Inappropriate Intimacy某些类相互之间太亲密，它们花费了太多的时间去砖研别人的私有部分。对人类而言，我们也许不应该太假正经，但我们应当让自己的类严格遵守禁欲

16、主义。47. Alternative Classes with Different Interfaces做相同事情的方法有不同的函数signature，一致把它们往类层次上移，直至协议一致。48. Incomplete Library Class要建立一个好的类库非常困难。我们大量的程序工作都基于类库实现。然而，如此广泛而又相异的目标对库构建者提出了苛刻的要求。库构建者也不是万能的。有时候我们会发现库类无法实现我们需要的功能。而直接对库类的修改有非常困难。这时候就需要用各种手段进行Refactoring。49. Data Class对象包括状态和行为。如果一个类只有状态没有行为，那么肯定有什么

17、地方出问题了。50. Refused Bequest超类传下来很多行为和状态，而子类只是用了其中的很小一部分。这通常意味着你的类层次有问题。51. Comments经常觉得要写很多注释表示你的代码难以理解。如果这种感觉太多，表示你需要Refactoring。Eclipse配置方法52. 注释模板在eclipse 的preferences 中，选择 java code style code Template 1. 添加文件创建日志模板2.设置类注释模板53. 导入方法在eclipse 的preferences 中，选择 java code style code Template 中选择 Import，选择附件中的文件。但是注意修改 类注释 和 文件注释 的作者名称为自己的！54. 格式化模板在eclipse 的preferences 中，选择 java code style formatter 中选择 Import，选择附件中的文件。55. XML格式化在eclipse 的preferences 中，选择 xml xml files xml editor 中 做如下设置