Java代码编写规范.docx

内部编号：(YUUT-TBBY MMUT-URRUY-UOOY DBUY1-0128) JAVA编码规范 南京朗坤软件有限公司 2004年南京朗坤自动化有限公司版权所有 机密文档，未经授权，不得外传 文档类型: 编码规范 作者:日期： 作者: 日期： 版本： 客户： 发布人员 文档审核 文档批准 技术平台小组 南京朗坤软件有限公司 南京市江宁区铜山金铜路2号 211156 电话:+86 25 传真：+86 25 Web： 2004 年8月31日 年一月一口 年__月__日 年一月_口 修正记录 版本 日期 作者 修改描述 2004-8-31 技术平台小组 初稿 1概述 1.1背景 程序的编码是一个创造性极强的工作，虽然要奇思妙想，但也必须要遵守一 定的规则和限制，编码风格的重要性对大型软件项目开发来说是不言而喻的。 Liems3产品开发基于Java语言J2EE技术路线，为了规范Java编码、提高编 码质量、增强代码的可读性和可维护性特制定本规范。 开发工程师在开发过程中必须遵守本规范，规范是代码编写及代码验收等管 理环节中必须执行的标准。 1.2读者对象 本手册的读者对象为Java开发工程师和测试工程师。 1.3商讨 对规范如有疑问请及时和技术平台小组联系。 2基本原则 以下是开发过程中必须遵循的基本原则，可能缺乏操作性，却是后续规范的 概括和总结。对暂未能列入本编码规范的问题，作一般性要求。 2.1 一开始就必须正确的使用规范 为保证整个产品编码风格的一致性，要求在产品的第一个模块开始，必须严 格使用本规范开始编码。 2.2简易性原则 代码的编写力求简易性，构建类和方法力求简単，提高代码的可读性和可维 护性。 2.3清晰性原则 确保每一个类、接口、方法、变量和对象都有清楚的功能，并解释在何时、 何地使用。设计人员应确保此原则的贯彻执行。 2.4健壮性原则 程序要健壮，要为错误和异常提供可预见的处理，不能隐藏错误和异常。 2.5效率原则 编码要兼顾程序运行期效率。 3格式规范 3.1代码缩进 所有的语句块内部需要缩进，语句块通常被｛｝包围，它包括但不仅包括类定义, 函数定义，条件分支，循环体 釆用两个空格来进行代码缩进，增强可读性，不要使用太多的空格。 class MyClass ( .void function(int arg) ( ...if (arg 0) { for (int index = 0; index = arg; index++) { } 另外，在程序块中，对于一个用于处理循环的结构，也要使用缩进，以突出 结构显示： void funcition (int arg) { …loop： ....for (int index = 0; index = arg; index++) ( switch (index) ( case 0: break loop; default; break; . ... } ?? ??} ) 在每一个代码块中，对于最后字符为{的一行，在{”前加上空 格：”}独占一行，同时首字符与这个代码块对齐。下面的例子阐明运用这条 规则是如何来进行JAVA的定义与结构控制的： 3.2分解较长的行 为了确保源代码在打印时仍然可读，限制源代码中行的最大长度，以满足打 印的要求，尽量控制在每行不超过80个字符，每行不允许超过100字符。 1.不允许在一行上编写多个表达式： 错误：double x = () ; double y =();如果存在复杂的表达式： double length = , + (Math .random (),);. Boolean equals(Object obj) ( return this = obj | (obj instanceof MyClass ■ ? } 这种情况下，建议采用最低优先级的操作来进行划分，或是存在一个比“等 于”高的优先级操作来进行划分： class Myclass ( private int field; ? ? ? Boolean equals (Object obj) { return this = obj (obj instanceof MyClass ==; 方法三 在需要的时候，重复应用方法一和方法二，直到每一行代码都小于最大的允 许的长度。 对于函数的定义，太长时折行，优先将throws子句断行，其次将类似参数尽量位 于同一行，如 Public void drawRect (int x, int y, Int width, int height, int color) throws Exception { 3.3空白区域的使用 代码中空白区域使用不当