JAVA编程规范92824.docVIP

目 录 目 录 2 1. 文档说明 4 1.1. 内容和有效性 4 1.2. 文档修改 4 1.3. 保密 5 2. 编程宗旨 5 2.1. 软件编码规范的目的 5 2.2. 对程序员的要求 5 2.3. 宗旨 6 3. 程序书写 6 3.1. 程序书写风格 6 3.1.1. 培养良好的程序风格 6 3.1.2. 程序书写规范 6 3.2. 注释 7 4. Java命名规则 7 4.1. 命名综述 7 4.2. Java命名规范 8 4.2.1. Java程序命名规则 8 5. Java注释规则 10 5.1. 注释规则综述 10 5.2. 注释规则描述 10 5.2.1. 类的注释 10 5.2.2. 方法的注释 11 5.2.3. 属性的注释 12 5.2.4. 一般内容的注释 13 5.2.5. 有关修改的注释 13 6. Java逻辑结构规则 15 6.1. if语句规范 15 6.2. 循环语句规范 16 6.3. switch语句和break语句规范 18 7. Java通用编码规则 20 7.1. import的包名顺序 20 7.2. “{}”使用规范 21 7.3. 小括号使用规范 22 7.4. 空格使用规范 22 7.5. 缩进规范 24 7.6. JavaBean的存取方法规范 24 7.7. toString方法规范 26 7.8. main方法规范 27 7.9. 一行里的字符个数规范 27 8. 编程工具的使用 28 9. 程序源码的保护 28 文档说明 内容和有效性 本文档《JAVA编程规范》定义了JAVA项目的编码(Coding)和调试(Debugging)阶段中，程序的书写规范。内容包括： 编程宗旨 程序书写 命名规则 java编码规范 本文档属于规章制度性文档，所有首都信息发展股份有限公司电子社区事业部(以下简称社区部)的软件开发人员必须认真阅读并理解。 所有社区事业部的软件项目中，如果涉及到使用java进行编程工作，编程人员必须按照本文档中的有关规定，进行编码和调试。 本文档的有效性作用于电子社区事业部的开发人员在为本部门的项目进行软件开发工作时。 本文档在版本更新时，所有按照旧版本进行开发的项目继续沿用旧版本规范；所有新项目必须遵循新版本规范。 本文档中指导性用词说明如下： “必须”指所述内容或规范属于强制性的执行要求； “要求”指所述内容在将来必须做到，目前做不到的应尽量改正以做到； “应该”指所述内容应尽可能做到； “建议”指所述内容属于指导性意见，以能做到为好； “不得”表示在未经主管人员同意的情况下不允许； “严禁”表示严格禁止。 文档修改 软件开发人员无权对本文档进行修改。 软件开发人员可以对本文档提出修改意见。 本文档由软件质量及过程管理负责人进行修改，修改草案由项目管理部门确认以后提交新版本。 保密 本文档属于公司机密文件，本公司职工有责任和义务对本文档内容进行保密。 严禁公司职工将本文档的软、硬拷贝私自带出或送出公司，严禁公司职工私自将本文档的软、硬拷贝提供给非本公司人员。 编程宗旨 软件编码规范的目的 使用统一编码约定集的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解编码。 好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。 以下给出程序书写有关规范： 程序必须使用逐层缩进的格式； 程序中必须有注释(有关注释使用规范在随后章节中单独说明)； 建议分行书写复杂表达式和复杂语句； 方法中的程序段不宜过长； 除在极为特殊的情况下，禁止使用系统或其它软件开发包提供的未公开的函数调用。 注释 注释的使用遵循以下规范： 要求使用注释在程序开头说明本程序的实现功能，建议用注释标明程序作者和时间，以及需要说明的其它事项； 较多的常量定义和属性定义处，要求用注释说明变量和属性的情况； 如果对别人的程序进行修改，必须在主要的修改处用注释说明所作的修改，并标明修改者； 要求用注释说明方法的功能、参数、异常以及返回值，有多个返回值时应说明不同返回值的值、及返回值意义； 同一程序段中进行不同的操作时，要求用注释说明一组程序的功能； 大段改动程序时，建议用注释屏蔽旧的程序段，以避免修改时增加新错误，避免可能的程序恢复。 Java命名规则 命名综述 命名包括对程序中文件、变量、属性、方法等程序对象的命名。 好的命名风格将有助于提高程序可读性，并易于修改和维护，从而减少错误，提高编程效率。 除简单使用的变量(如用于循环计数的变量)外，变量的名称必须有意义，以便于识别该对象；但不宜过长，以避免使用中键入时出错。 软件的最终发布性文件，包括最终的可执行程序、动态链接库、帮助文件等文件的命名，由项目负责人统一确定。 软件的最终使用性名称，包括