2022年2022年科瑞尔思项目开发编码规范 .pdf

《2022年2022年科瑞尔思项目开发编码规范 .pdf》由会员分享，可在线阅读，更多相关《2022年2022年科瑞尔思项目开发编码规范 .pdf（6页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、科瑞尔思项目开发编码规范一、规范目的对于代码，首要要求是它必须正确，能够按照程序员的真实思想去运行；第二个要求是代码必须清晰易懂，使别的程序员能够容易理解代码所进行的实际工作。在软件工程领域，源程序的风格统一标志着可维护性、可读性，是软件项目的一个重要组成部分。二、整体编码风格1.所有程序都必须包含有清晰、明了的注释。Java程序使用标准的Java 代码注释格式书写。在项目完成时，所有的Java 代码文档也应该同时完成。2.缩进、空格、换行等应该合理使用。缩进建议以4 个空格为单位。原则上变量、类、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：if ( .

2、) 等。运算符的空格规定如下：: 、- 、 、 、+ 、- 、! 、+ 、- （指正负号） 、& （引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边） ，其它运算符 （包括大多数二目运算符和三目运算符?:两边均加一空格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。, 运算符只在其后空一格，需对齐时也可不空或多空格。不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。3.对齐：原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在, 处或运算符处，换行后最好

3、以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“ ”应与首行对齐。变量定义最好通过添加空格形成对齐，同一类型的变量最好放在一起。如下例所示：int Value; int Result; int Length; Object currentEntry; 4.空行：不得存在无规则的空行，比如说连续十个空行。程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行，由于每个函数还要有函数说明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。对自己写的函数，建议也加上“/- ”做分隔。函数内部数据与代码之间应空至少一行，

4、 代码中适当处应以空行空开，建议在代码中出现变量声明时，在其前空一行。5.注释注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%，软件工程要求不少于20%。程序注释不能用抽象的语言，类似于处理 、循环 这样的计算机抽象语言，要精确表达出程序的处理说明。例如：计算净需求 、计算第一道工序的加工工时等。避免每行程序都使用注释，可以在一段程序的前面加一段注释，具有明确的处理逻辑。注释必不可少， 但也不应过多， 不要被动的为写注释而写注释。以下是四种必要的注释：i.标题、附加说明。ii.函数、 类等的说明。 对几乎每个函数都应有适当的说明，通常加在函数实现之名师资料总结 - - -精品资料

5、欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 6 页 - - - - - - - - - 前，在没有函数实现部分的情况下则加在函数原型前，其内容主要是函数的功能、目的、算法等说明，参数说明、返回值说明等，必要时还要有一些如特别的软硬件要求等说明。公用函数、 公用类的声明必须由注解说明其使用方法和设计思路，当然选择恰当的命名格式能够帮助你把事情解释得更清楚。iii.在代码不明晰或不可移植处必须有一定的说明。iv.及少量的其它注释，如自定义变量的注释、代码书写时间等。v.注释有块注释和行注释两种，分别是指

6、：/*/ 和/ 建议对 i 用块注释， iv 用行注释， ii、iii 则视情况而定，但应统一，至少在一个单元中ii 类注释形式应统一。具体对不同文件、结构的注释会在后面详细说明。6.代码长度 : 对于每一个函数建议尽可能控制其代码长度为53 行左右，超过 53 行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该：i.不破坏原有算法为基础ii.拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码， 完全可以将起独立成为一个具备公用性质的函数，放置于一个公用模块中。7.页宽页宽应该设置为80 字符。源代码一般不会超过这个宽度, 并导致无法完整显示, 但

7、这一设置也可以灵活调整. 在任何情况下 , 超长的语句应该在一个逗号或者一个操作符后折行 . 一条语句折行后, 应该比原来的语句再缩进2 个字符。8.行数一般的集成编程环境下，每屏大概只能显示不超过50 行的程序，所以如果有的函数大概要 5-6 屏或以上才能显示完的话，无论是读程序还是修改程序，都会有困难。因此建议把完成比较独立功能的程序块抽出，单独成为一个函数。把完成相同或相近功能的程序块抽出，独立为一个子函数。可以发现，越是上层的函数越简单，就是调用几个子函数，越是底层的函数完成的越是具体的工作。这是好程序的一个标志。这样， 我们就可以在较上层函数里容易控制整个程序的逻辑，而在底层的函数里

8、专注于某方面的功能的实现了。三. 代码文件风格1.所有的 Java(*.java) 文件都必须遵守如下的样式规则i.package 行要在 import 行之前， import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。ii.文件头部注释主要是表明该文件的一些信息，是程序的总体说明，可以增强程序的可读性和可维护性。文件头部注释一般位于 package/import 语句之后，class 描述之前。要求至少写出文件名、创建者、创建时间和内容描述。如：/* * Title: 时钟类* Description: 取得当前日期、时间* Copyright: Copyright (c) 20

9、02 * Company: Careers * author: xxx * version: 1.0 * time: 2004.8.10 */ iii.接下来的是类的注释，一般是用来解释类的，如：/* 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 6 页 - - - - - - - - - * 通过这个类，可以以多种形式返回系统当前的日期、时间 */iv.接下来是类定义v.再接下来是类的成员变量vi.类变量的存取的方法：/* * Get the YEAR * retur

10、n 当前系统时间的“年”值*/ public int getYear() return this.year; public void setYear(int year) this.year = year; vii.接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型(public,private 等 .)和任何 static,final或synchronized 应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。viii.克隆方法如果这个类是可以被克隆的，那么下一步就是 clone 方法：public Object clone() try CounterS

11、et obj = (CounterSet)super.clone(); obj.packets = (int)packets.clone(); obj.size = size; return obj; catch(CloneNotSupportedException e) throw new InternalError(Unexpected CloneNotSUpportedException: + e.getMessage(); ix.类方法x.toString 方法，无论如何，每一个类都应该定义 toString 方法xi.main 方法如果类含有main(String) 方法，那么它应该

12、写在类的底部. 四.函数编写风格名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 6 页 - - - - - - - - - i.函数的命名通常， 函数的命名是以能表达函数的动作意义为原则的，一般是由动词打头，然后跟上表示动作对象的名词，各单词的首字母应该大写。另外， 还有一些函数命名的通用规则。如取数，则用Get 打头，然后跟上要取的对象的名字；设置数，则用Set 打头，然后跟上要设的对象的名字；而对象中为了响应消息进行动作的函数，可以命名为On 打头，然后是相应的消息的

13、名称；进行主动动作的函数，可以命名为 Do 打头，然后是相应的动作名称。ii.函数注释对于自行编写的函数，若是系统关键函数，则必须在函数实现部分的上方标明该函数的信息，格式如下：/* * 功能：* 输入参数：* return * 备注：*/ 五.符号风格i.总体要求对于各种符号的定义，都有一个共通点，就是应该使用有实际意义的英文单词或英文单词的缩写， 不要使用简单但没有意义的字串，尽可能不使用阿拉伯数字，更切忌使用中文拼音的首字母。ii.变量名称变量类型前缀示例integer int intCount byte byt bytMove short sht shtResult long lng

14、lngTotal float flt fltAverage double dbl dblTolerangce boolean bln blnIsover Char chr chrInput Array arr arrData 变量名一般要有一定的表达义,变量名中的每一个单词的第一个字母都要大写出（除去第一个单词外）iii.描述性变量名和过程名变量名或过程名的主体使用大小写混合格式并且尽量完整地描述其目的，另外过程名应以动词开始如：InitNameArray ,CloseDialogiv.对象名的约定对象类型前缀Button btn Canvas cvs CheckBox chk Image i

15、mg Label lbl List lst 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 6 页 - - - - - - - - - Choice chc Dialog dlg Event evt Frame frm Menu menu Panel pnl TextArea txa TextField txf v.Package 的命名Package 的名字应该都是由一个小写单词组成。vi.Class 的命名Class 的名字必须由一个或数个能表达该类的意思的大写字母开

16、头而其它字母都小写的单词或缩写组成，这样能使这个 Class 的名称能更容易被理解。vii.Class 变量的命名变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。对于类的成员变量，在对其标识符命名时，要加上代表member（成员）的前缀m_。例如一个标识符为m_dwFlag，则它表示的变量是一个类型为双字的成员变量，它是代表一个标志。viii.Static Final 变量的命名Static Final 变量的名字应该都大写，并且指出完整含义。ix.参数的命名参数的名字必须和变量的命名规范一致。x.数组的命名数组应该总是用下面的方式来命名：byte buffer; 而不是：byte

17、 buffer; xi.方法的参数使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：SetCounter(int size) this.size = size; 六.其他统一标准i.请勿重复发明轮子。若实现某项功能的程序，已有成员完成了，则个人请勿再自行开发，而应该采用已完成的程序。但任何人皆可以该程序的基础上添加某项功能。因此个人在开发一些多个页面中经常会使用到的程序时，请先到公共类库中查找是否已存在了实现该功能的程序。ii.所有程序、页面，其版权都属于科瑞尔思。iii.Java包命名：以cn.itcareers 包名开始iv.表单传递参数命名：请一律用小写英文名全称，若有两

18、个单词，请用下划线连接。如： user_name 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 6 页 - - - - - - - - - v.Web 项目目录结构：/存放 class 文件/js 存放 JavaScripts 文件/lib 存放 class文件打包 jar 文件/存放 include 文件/存放样式表文件/存放图片文件/管理模块index.html /统计分析/检索模块/其他模块WEB-INF inc js images css jsp lib classes admin stat search others cis 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页，共 6 页 - - - - - - - - -