分享
 
 
 

软件开发规范(2)

王朝other·作者佚名  2008-05-31
窄屏简体版  字體: |||超大  

软件开发规范(2)

4.4 数据库命名规范

数据库表命名均遵循以下规范:

模块名_存储信息名词(多个单词用下划线分隔),全部小写,例如:ebwebmail_message。

数据库字段命名遵循以下规范:

存储信息名词(多个单词用下划线分隔),全部小写,例如:message_id。

5 文档规范

1. 编写文档目前主要使用的工具是Word(项目计划文档例外,需要使用Project制作),辅助使用的工具有Visio,Powerpoint,ERWin等。

2. 文档务必保持段落格式整洁,文字字体,颜色,大小统一。

3. 假如需要摘引Html页面中的内容,不能直接从html中粘贴过来(会在word文档中留下html格式),而必须先去除格式,例如:先粘贴到notepad中。

4. 务必注重中英文标点符号,文档正文一概使用中文标点符号。

5. 假如需要在文档中插图,不要使用word自带的绘图工具。可以选择使用PowerPoint或visio。使用PowerPoint,选择“插入”->“对象”->“Microsoft PowerPoint 幻灯片”。使用visio,需要另外建立visio文档,绘制完以后粘贴到word中。

6. 数据建模使用ERwin工具,文档中仅需要粘贴数据模型的逻辑视图(logical view),另外还要附上表结构描述。

7. 修改他人文档务必使用修订模式,以便保留备修改的内容。使用修订模式,选择“工具”->“修订”->“突出显示修订”,勾上“编辑时标记修订”。

附:一些模版

ü Java类设计(class documentation)

声明:

描述:

属性:

1. property_name

声明

说明

方法:

1. method_name

声明

说明

参数

返回值

异常

注:

方法声明中,假如碰到重载的方法,可以使用“”表示可以接受不同类型的参数,例如:“String value int value”;可以使用“[]”表示可选的参数,例如:“Object message[,Throwable t]”

ü Servlet设计(servlet document)

类名 接受参数列表 描述

ü 数据表设计(data modeling)

表名:some_table

说明:description

表结构:

字段名 类型 说明

6 代码规范

6.1 Java源代码规范

6.1.1 命名

u Package 的命名

Package 的名字应该都是由一个小写单词组成,例如:net.ebseries.modules。

此外,对于包名我们做如下约定:

1. 工具函数类包名前缀为.util

2. Servlet类包名前缀为.servlet

3. test case类包名前缀为.test

u Class 的命名

Class 的名字必须由大写字母开头而其他字母都小写的单词组成,例如:DataFile或InfoParser。

u Class 变量的命名

变量的名字必须用一个小写字母开头。后面的单词用大写字母开头,例如:debug 或 inputFileSize。

u Static Final 变量的命名

Static Final 变量的名字应该都大写,并且指出完整含义,例如:MAX_UPLOAD_FILE_SIZE=1024。

u 参数的命名

参数的名字必须和变量的命名规范一致。

u 数组的命名

数组应该总是用下面的方式来命名:

byte[] buffer;

而不是:

byte buffer[];

u 方法的参数

使用有意义的参数命名,假如可能的话,使用和要赋值的字段一样的名字:

SetCounter(int size)

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有