程序开发规范性文档.docVIP

开发规范性文档 目 录 第1章 1 1.1 Java Package命名规则 1 1.2 类接口命名 2 1.3 方法名 2 1.4 变量名 3 1.5 数组 3 1.6 集合 4 1.7 泛型 4 1.7.1 泛型命名要点 4 1.7.2 推荐的命名 4 1.8 符号 5 1.8.1 花括号 5 1.8.2 括号 6 1.8.3 空格 6 1.8.4 类 6 1.8.5 构造函数 7 1.8.6 成员变量 7 1.8.7 方法 7 第2章 8 2.1 注释形式统一 8 2.2 注释内容准确简洁 8 2.3 注释条件 8 2.4 注释格式 9 第3章 12 命名规范 1.1 Java Package命名规则 包名按照域名的范围从大到小逐步列出，恰好和Internet上的域名命名规则相反。Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都 可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。 由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 indi ： 个体项目，指个人发起，但非自己独自完成的项目，可公开或私有项目，copyright主要属于发起者。 包名为“indi.发起者名.项目名.模块名.……”。 pers ： 个人项目，指个人发起，独自完成，可分享的项目，copyright主要属于个人。 包名为“pers.个人名.项目名.模块名.……”。 priv ： 私有项目，指个人发起，独自完成，非公开的私人使用的项目，copyright属于个人。 包名为“priv.个人名.项目名.模块名.……”。 onem ： 与“indi”相同，推荐使用“indi”。 另外，我为了区分团队项目和前面所说项目的区分，还有了一下扩展： team ： 团队项目，指由团队发起，并由该团队开发的项目，copyright属于该团队所有。 名为“team.团队名.项目名.模块名.……”。 com ： 公司项目，copyright由项目发起的公司所有。 包名为“com.公司名.项目名.模块名.……”。 类接口命名 　 类的名字必须由大写字母开头而单词中的其他字母均为小写; 如果类名称由多个单词组成，则每个单词的首字母均应为大写 例如TestPage; 如果类名称中包含单词缩写，则这个所写词的每个字母均应大写， 如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。 1.3 方法名 　 方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。可以为动词或动词+名词组合。 设置/获取某个值的Method，应该遵循setV/getV规范 返回长度的Method，应该命名为length 测试某个布尔值的Method，应该命名为isV 将对象转换为某个特定类型的Mehod应该命名为toF etDate(); length(); isReady(); toOracleFormat(); 。。。。。 总之，取方法名时，能让其他开发人员一看就能大概明白方法的作用。可以配合注释使用，效果更佳。 1.4 变量名 普通变量命名应该采用首字母小写，其他字母首字母大写的方式。 final static变量的名字应该都大写，并且指出完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词如。 NUM_DAYS_IN_WEEK ；MAX_VALUE 如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性 例如：context=ctx ；message=msg 通过在结尾处放置一个量词，就可创建更加统一的变量 First(一组变量中的第一个) Last(一组变量中的最后一个) Next(一组变量中的下一个变量) Prev(一组变量中的上一个) Cur(一组变量中的当前变量) 无论什么时候，均提倡应用常量取代数字、固定字符串。也就是说，程序中除0，1以外，尽量不应该出现其他数字。 索引变量：i、j、k等只作为小型循环的循环索引变量。 逻辑变量：避免用flag来命名逻辑变量，用is来命名逻辑变量。 if(isClosed){ dosomeworks; return; } 数组 　　总是使用以下方式定义数组： 　　int[] arr = new int[10]; 禁止使用C语言的形式： int arr[] = new int[10]; 集合 　　数组或者容器推荐命名方式为名词+s的方式，例如： List?persons = getPersons(); 或者在集合名中加入集合的类型： Map acco