欢迎来到天天文库
浏览记录
ID:12920196
大小:88.92 KB
页数:24页
时间:2018-07-19
《网络在线考试系统软件实现》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、软件实现网络在线考试系统姓名:班级:计科1201学号:1211100122目录1引言11.1目的和作用11.2文档概述12编码规范12.1文件组织12.2文件格式标准22.3注释32.4声明62.5语句(Statements)72.6命名规范112.7代码范例(CodeExamples)13221引言1.1目的和作用衡量一个程序的质量,主要有两个方面:运行质量和代码质量。一个稳定运行的程序并不等同于优良的程序,有可能其源代码可读性极差,不具有低成本的可维护性,以后的升级或者新员工接手时都会非常困难,对公司来说,意味着更高的资源投入,对工程师来说,意味着精力时间的浪费,甚
2、至会引起对程序的抵制情绪,导致推翻重新实现,降低了软件复用度。当然,程序的运行质量是必须保证的,否则代码再规范也是一个废品。事实上,程序的不良书写风格和错误的写法往往是滋生错误的温床,而且很大一部分反复出现的错误是同一个原因造成的。本文档结合一些常见的错误或者危险的代码,规定了编码的规范,按照规范上的要求编码,不仅可以使不同人写的代码看起来很统一,降低了交流的障碍和工作转接的成本,而且能够规避很多反复出现的程序错误。1.2文档概述该规范定义了良好的编程风格,内容涉及排版,可读性,可维护性,可测性等方面。2编码规范2.1文件组织每个Java源文件包含一个单独的Public
3、类接口或接口。当private类和接口与某个Public类有关部门时,可以把他们放在同一源文件中作为Public类。Public类应为文件中第一个类或接口。Java源文件中有下列顺序:(1)开头注释;(2)包和引用声明,如:22packageedu.cnu.lms.utils;importjava.sql.Connection;importjava.sql.DriverManager;(3)类和接口定义下面表格按序定义了一个类或接口的定义的各个部分。表5.1类和接口定义序号类/接口定义部分说明1类/接口文档注释(/**….*/)见注释2类/接口声明3类/接口执行注释可选
4、,需包含不在类/接口文档注释的关于类/接口的所有信息4类静态变量先是Public类变量,再protected,再private5实例变量同上6构造函数7方法按功能排序2.2文件格式标准2.2.1缩排缩排的单位,逻辑Tab键,统一缩进为4个字符。2.2.2换行当一个表示不能在一行内写完时,按以下规则断行:在逗号后断行。在操作符前断行。宁可选择较高级别(higher-level)的断开,而不是较低级别(lower-level)的断开。新的一行应该与上一行同一级别表达式的开头处对齐。如果以上规则导致代码混乱或者使代码都堆挤在右边,那就代之缩进8个空格。222.2.3空白应谨慎
5、使用空行来突出代码。例:在循环和条件块前后至少有一个空行。函数间至少有一个空行。注释前至少有一个空行。2.2.4行长度尽量避免一行的长度超过80个字符,因为很多终端和工具不能很好处理之。注意:用于文档中的例子应该使用更短的行长,长度一般不超过70个字符。2.2.5数值语句不要用硬性代码数值。用符号常量。例:nTimeout=3000;//BAD!!NTimeout=MAX_ABC_DURATION;//Good2.3注释注释是帮助程序读者的一种手段。最好的注释是简洁地点明程序的突出特征,或是提供一种概观,帮助别人理解程序。Java程序有两类注释:实现注释(impleme
6、ntationcomments)和文档注释(documentcomments)。实现注释使用/*……*/和//界定的注释。文档的注释(被称为“doccomments”)是Java独有的,并由/**……*/界定。文档注释可以通过javadoc工具转换HTML文件。222.3.1文件头注释一个文件由被空行隔开的节和可选的标识节的注释组成。一个包声明和接口声明需用至少一个空行隔开。每个文件需在开头包括一个注释块,提供以下信息:版权声明,修改历史。/**数据库连接管理类*@authorWangLiyun*@version1.0*/2.3.2类注释每个源文件需在类声明前包含一个注
7、释,提供以下信息:作者,版本。/***
*Windowwin=newwindow(parent);*win.show();*
此文档下载收益归作者所有