学生学籍管理系统开发规范.doc

《学生学籍管理系统开发规范.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、学生学籍管理系统开发规范文档编写：马莉文档最后更新时间：2007-1-7前言：为了保证我们小组的成员在实际程序代码编写时能有效地合作与沟通，代码整合时不出现很多的问题，确定小组成员编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。目录结构规范：所有JavaBean以及Servlet文件均放在com.qichunren下的相应的包中，如连接数据库的Bean文件位于com.qichunren.database里，获取各种样式的各种时间的Bean文件还有系统创建学号的Bean文件均位于com.q

2、ichunren.util里.(注：此util包中放各种实用类)。程序界面的图片文件位于images下，学生照片文件位于upload/stntphoto下，学生荣誉证书图片位于upload/honourpic下。数据库设计及命名规范：数据库名为StuDB。表名以ta_作为前缀，然后根据的表记录的对象，以其英文件单命名，如ta_admin（管理员表），如果不足以用一个单词来描述一个表的意思，需要用多个单词来对表进行描述，除首单词小写，以后的每一个单词的首字母大写，如果表名太长，使用单词缩写，如ta_stntCo

3、urse（学生课程表）。表中的字段也是如此，以英文件单词或者多个单来描述其意思，如stntId(学号)。总之，命名的原则是：简洁而意思清楚，不产生异义，代码编写人员易懂，能提高程序开发效率。程序变量规范：l变量统一使用英文单词或者多个单词描述，除首单词小写，以后的每一个单词的首字母大写。l在变量名中使用互补对，如min/max、begin/end和open/close.l布尔变量名应该包含Is，这意味着Yes/No或True/False值，如fileIsFound。l即使对于可能仅出现在几个代码行中的生存期很

4、短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如i或j。文件命名规范：文件名统一使用英文单词或者多个单词描述，除首单词小写，以后的每一个单词的首字母大写。如果某文件是防止未登录用户访问的，则加上admin_前缀，如admin_index.jsp。录入信息的页面一般是这样的格式命名：admin_addXxx.jsp,如admin_addAdmin.jsp（添加管理员的页面，是一个输入表单），然后在处理此表单请求的页面的命名是在表单页面加_post后后缀即可，如admin_addAdmin_p

5、ost.jsp(处理表单传来的数据，将新管理信息的记录插入到数据库)文件编码规范：为能有效地解决中文乱码问题，所有文件编码采用utf-8字符集编码。对于JSP文件，在程序段中所使用的变量要求使用英文命名，严禁使用inta=0;Stringstr=”***”之类的随意命名。在jsp文件的头部加入以下示例代码:<%--'====================================================================='软件名称：学生学籍管理系统'当前版本：StudentIn

6、formationManagementSystemVersion1.0.0'文件名称：index.jsp'文件描述：学生学籍管理系统，提供系统登录入口'更新日期：2007-1-1'====================================================================='程序开发：05级软件技术四班第四项目第六小组'文件作者：曹金华'=================================================================

7、===='Copyright2006-AllRightsReserved.www.qichunren.com'=====================================================================--%>对于JAVA文件，要在程序开头说明类的编写时间、编写人、审核人，注释中说明类的作用，类中的方法的作用，方法的使用方法等。示例：/**创建于2007-1-6*创建了一个简单的javaBean，连接数据库*包名为useBean,类名为Link_db.*创建人：贺

8、大锋审核人:曹金华*/packagecom.qichunren.database;importjava.sql.*;/*****************************************************类名称：Link_db
*类功能：数据库连接操作
*创建：贺大锋2007年1月6日
**************************************