JAVA开发编码规范

J__A项目__编码规范一、目的 对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。在软件工程领域,源

J__A项目__编码规范 一、目的 对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求 是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。在软件工程领域, 源程序的风格统一标志着可维护性、可读性,是软件项目的一个重要组成部分。而目前还没 有成文的编码风格文档,以致于很多时候,程序员没有一个共同的标准可以遵守,编码风格 各异,程序可维护性差、可读性也很差。通过建立代码编写规范,形成__小组编码约定,提 高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,可以保证程序代码的 质量,继承软件__成果,充分利用资源,使__人员之间的工作成果可以共享。 本文在参考业界已有的编码风格的基础上,描述了一个基于Eclipse的项目风格,力 求一种统一的编程风格,并从整体编码风格、代码文件风格、函数编写风格、变量风格、注 释风格等几个方面进行阐述。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好 的可读性) 二、整体编码规则 1、缩进 缩进建议以4个空格为单位。建议在Tools/EditorOptions中设置Editor页面的 Blockident为4,TabSize为8。预处理语句、全局数据、标题、附加说明、函数说明、标 号等均顶格书写。语句块的"{"、"}"配对对齐,并与其前一行对齐,语句块类的语句缩进建 议每个"{"、"}"单独占一行,便于匹对。JBuilder中的默认方式是开始的"{"不是单独一行, 建议更改成上述格式(在Project/DefaultProjectProperties中设置CodeStyle中选 择Bra__s为Nextline)。 2、空格 原则上变量、类、常量数据和函数在其类型,修饰名称之间适当空格并据情况对齐。关 键字原则上空一格,如:if(...等。运算符的空格规定如下:"::"、"->"、"["、"]"、 "++"、"--"、"~"、"!"、"+"、"-"(指正负号)、"&"(引用)等几个运算符两边不加空格 (其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目 运算符"?:"两边均加一空格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实 现时可以不用。","运算符只在其后空一格,需对齐时也可不空或多空格。不论是否有括号,

腾讯文库JAVA开发编码规范