java编码规范9(附考核内容).docVIP

Java编码规范 修订历史记录 日期 版本 说明 作者 审核人 2011-7-11 0.0.1 对Java代码风格、注释、命名、声明等规范进行描述 黎建宁 2011-8-5 0.0.2 根据征询意见对Java编码规范进行修订 黎建宁、冯彬杰、张史沛、李思行 2011-8-16 0.0.3 对规范中出现模糊定义的地方进行细化描述 黎建宁 2011-9-13 0.0.4 根据编码的约定情况，对注释、声明部分进行了补充 黎建宁、李思行 2011-9-20 0.0.5 对方法的声明顺序进行补充 黎建宁、李思行 一 简介 1 目的 本规范的目的是使开发人员以标准的、规范的方式编写代码，养成良好的编码风格和习惯，形成公司内部编码约定，提高程序的可读性，可维护性以及一致性，同时减少项目组成员间技术沟通成本，提高团队开发效率。 2 范围 1、本文档基于Java1.5的语法描述编码规范。 2、本文档从代码风格、注释、命名、声明以及异常处理等五个方面对Java编码进行约定。 3、本规范适用于所有运用Java技术的软件项目、产品。 4、本规范适用的文件类型包括但不限于Java源文件、JSP文件、XML文件、HTML文件、JS文件以及AS文件。 5、本规范建议采用统一的Code Style以及Formatter风格，通过IDE进行配置。 3 读者范围 1、软件过程改进领导小组以及工作小组所有人员； 2、所有运用Java技术的软件项目、产品的相关领导、项目负责人、设计人员、开发人员以及测试人员。 3、所有涉及运用Java技术的软件项目、产品的相关人员。 二 代码风格 1 缩进 1、使用空格代替Tab缩进，避免各种编辑器中看到不一样的代码格式。【注：强制执行，Eclipse可辅助排版】 2、代码按层级缩进，每层级缩进4个字符（对于特定格式文件，可以按照实际进行调整，如XML文件可缩进2个字符），所有“｛｝”块内容都应该进行缩进。【注：强制执行，Eclipse可辅助排版】 参考例子： 2 括号 1、除数组的初始化定义外，“｛｝”中的语句应单独作为一行。。【注：强制执行，Eclipse可辅助排版】 2、左括号“｛”可根据开发习惯是否换行存放，如果换行存放，必须与其前导语句首字符对齐，右括号“｝”必须作为单独一行存放并且与匹配行对齐（即左括号前导语句首字符）。。【注：强制执行，Eclipse可辅助排版】 3、在项目内部，相同类型的文件，其括号的风格必须统一。。【注：强制执行，Eclipse可辅助排版】 参考例子： 3 空格 1、操作符两端必须带有空格符。【注：强制执行，Eclipse可辅助排版】 参考例子： 2、各并行元素（如函数参数）间以空格符隔开，空格符放在逗号后方。 参考例子：【注：强制执行，Eclipse可辅助排版】 3、无特别要求，括号“{}”、“[]”、“()”左右方尽量不要增加无必要性的空格符。【注：强制执行，Eclipse可辅助排版】 参考例子： 4 空行 1、同一个编译单元间（包定义、导入声明、类）应以空行相隔。 参考例子：【注：强制执行，Eclipse可辅助排版】 2、类定义内部各元素间（字段定义、方法）应以空行相隔。 参考例子：【注：强制执行，Eclipse可辅助排版】 3、同一方法内实现不同的功能之间应以空行相隔。【注：强制执行】 4、不能无理由出现大片空行。【注：强制执行】 5 控制语句 1、对于循环控制等元素块，不管是否带有body，都应该以{}包含。 参考例子：【注：强制执行】 6 行宽 1、每行代码尽量控制行宽在100字以内，当超出100字时候，代码应当进行缩进。【注：非强制执行，属加分项】 2、方法的缩进应当保证参数对齐。【注：非强制执行，属加分项】 参考例子： 3、对于过长的SQL/HQL语句，则采用关键字对齐方式，具体可通过PL/SQL等工具进行代码的格式化。【注：非强制执行，属加分项，附带《sql规范》一并考核】 参考例子： 7 类、函数 1、每个函数的代码长度应尽量控制在50行以内（不包含注释），如果函数功能过于庞大，可把独立的功能段单独抽取出来作为子函数。【注：非强制执行，属加分项】 2、每个类的代码长度应尽量控制在1000行以内（不包含注释），如果类功能过于庞大，可通过组合的方式来分解类。【注：非强制执行，属加分项】 三 注释 1 基本原则 1、注释目的在于增加代码清晰度，使代码易于被其他开发人员理解。【注：强制执行】 2、保持注释简洁，禁止为了注释而注释。【注：强制执行】 3、注释除带有代码功能外，还应带有描述上下文意图，具体描述其原因。 4、除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。 5、对描述较长的注释，应当使用HTML标记进行格式化，便