软件开发规范v10.docx
- 文档编号:25643579
- 上传时间:2023-06-11
- 格式:DOCX
- 页数:54
- 大小:62.99KB
软件开发规范v10.docx
《软件开发规范v10.docx》由会员分享,可在线阅读,更多相关《软件开发规范v10.docx(54页珍藏版)》请在冰豆网上搜索。
软件开发规范v10
软件开发规范
***有限公司
修订历史记录
修订日期
版本号
修订说明
修订人
2011-11-01
V1.0
增加了报表部分规范
目录
1.目的和范围4
1.1.目的4
1.2.范围4
2.术语4
3.编码规范5
3.1.命名规范5
3.1.1.命名规则5
3.1.2.文件与文件夹命名5
3.1.3.对象命名5
3.1.4.常量命名6
3.1.5.变量命名6
3.1.6.例程命名7
3.1.7.数据库对象命名8
3.2.结构化代码规范9
3.2.1.代码注释9
3.2.2.格式化代码10
3.2.3.数据库11
4.提示信息规范12
4.1.通用提示12
4.2.成本特有的层级日期关联提示15
5.界面规范15
5.1.列表相关:
15
5.2.树形相关:
16
5.3.字段相关:
16
5.4.按钮相关:
17
5.5.提示信息的判断顺序:
17
5.6.窗体:
18
5.7.帮助设施:
19
5.8.菜单位置设置19
5.9.表单界面19
5.10.公用按钮图标19
5.11.其它:
20
6.报表制作规范21
6.1.报表版面21
6.1.1.整体21
6.1.2.报表表头21
6.1.3.报表明细22
6.1.4.分组、汇总22
6.2.报表取数22
6.3.其它22
1.
目的和范围
1.1.目的
本文的目的是对编码进行规范性定义,改善源代码的可读性,提升产品的可维护性,降低维护成本。
1.2.范围
本文详细描述了软件开发过程中所有编码实践需要遵循的编码规范。
(注:
本部分内容除特殊说明外,都为必须执行。
)
2.C#编码规范
3.1概述
3.1.1规范制定原则
◆方便代码的交流和维护。
◆不影响编码的效率,不与大众习惯冲突。
◆使代码更美观、阅读更方便。
◆使代码的逻辑更清晰、更易于理解。
3.1.2术语定义
Pascal大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用Pascal大小写。
例如:
BackColor
适合:
属性或公共变量
Camel大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写。
例如:
backColor
适合:
属性或公共变量
3.1.3文件命名组织
◆文件命名
✓文件名遵从Pascal命名法,无特殊情况,扩展名小写。
✓使用统一而又通用的文件扩展名:
C#类.cs
✓每个模块的文件尽量放在同一个文件夹下或每个文件的命名前缀为模块名。
◆文件注释
✓在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
//Copyright(C)2011PrimaxIT
//版权所有。
//
//文件名:
POVendorDetail.aspx
//文件功能描述:
//用来查看厂商订单的明细数据
//
//创建人:
Tony.Gao
//创建日期:
2011-10-11
//修改人:
Spark.Liang
//修改时间:
2011-10-15
//修改描述:
修改了在FireFox下图层不能显示的Bug
//
//修改人:
Xingang.Zhang
//修改时间:
2011-10-18
//修改描述:
修改了导出Excel发生乱码的Bug
//----------------------------------------------------------------*/
文件功能描述只需简述,具体详情在类的注释中描述。
同一个人一天内有多个修改的只需做一个在注释说明中做一个修改描述就够了。
在所有的代码修改处可加上修改标识的注释。
◆方法的代码行数尽量控制在60~70行内
3.2代码外观
3.2.1列宽
代码列宽控制在110字符左右。
3.2.2换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
1、在逗号后换行。
2、在操作符前换行。
3、规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
3.2.3空行
空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。
在以下情况下使用两个空行
1、接口和类的定义之间。
2、枚举和类的定义之间。
3、类与类的定义之间。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。
2、方法中变量声明与语句之间。
3、方法与方法之间。
4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。
6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行,但与其他的语句间空一行。
3.2.4空格
在以下情况中要使用到空格
1、关键字和左括符“(”应该用空格隔开。
如
while(true)
注:
在VS2008/2010中会代码会自动预留空格
注意在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。
2、多个参数用逗号隔开,每个逗号后都应加一个空格。
3、除了.之外,所有的二元操作符都应用空格与它们的操作数隔开。
一元操作符、++及--与操作数间不需要空格。
如
a+=c+d;
a=(a+b)/(c*d);
while(d++=s++)
{
n++;
}
PrintSize(“sizeis“+size+“\n”);
注:
在VS2008/2010中代码默认会按以上规则的格式。
4、语句中的表达式之间用空格隔开。
如
for(expr1;expr2;expr3)
3.2.5括号-()
1、左括号“(”不要紧靠关键字,中间用一个空格隔开。
2、左括号“(”与方法名之间不要添加任何空格。
3、没有必要的话不要在返回语句中使用()。
如
if(condition)
Array.Remove
(1)
return1
3.2.6花括号-{}
1、左花括号“{”放于关键字或方法名的下一行并与之对齐。
如
if(condition)
{
}
publicintAdd(intx,inty)
{
}
2、左花括号“{”要与相应的右花括号“}”对齐。
3、通常情况下左花括号“{”单独成行,不与任何语句并列一行。
4、if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。
如
if(somevalue==1)
{
somevalue=2;
}
5、右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。
如
while
(1)
{
if(valid)
{
}//ifvalid
else
{
}//notvalid
}//endforever
3.3程序注释
3.3.1注释概述
1、修改代码时,需要同步更新注释。
5、避免在块注释的周围加上印刷框。
这样看起来可能很漂亮,但是难于维护。
6、在部署发布之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。
7、如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。
尽一切可能不注释难以理解的代码,而应该重写它。
尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。
8、在编写注释时使用完整的句子。
注释应该阐明代码,而不应该增加多义性。
9、在编写代码时就注释,因为以后很可能没有时间这样做。
另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。
10、避免多余的或不适当的注释,如幽默的不主要的备注。
11、使用注释来解释代码的意图。
它们不应作为代码的联机翻译。
13、为了防止问题反复出现,对错误修复和解决方法代码总是使用注释,尤其是在团队环境中。
14、对由循环和逻辑分支组成的代码使用注释。
这些是帮助源代码读者的主要方面。
15、在整个应用程序中,尽量使用一致的注释格式。
18、为了层次清晰,在闭合的右花括号后注释该闭合所对应的起点。
namespaceLangchao.Procument.Web
{
}//namespaceLangchao.Procument.Web
3.3.2文档型注释
该类注释采用.Net已定义好的Xml标签来标记,在声明接口、类、方法、属性、字段都应该使用该类注释,以便代码完成后直接生成代码文档,让别人更好的了解代码的实现和接口。
如
///
///
///
///forinformationaboutoutputstatements.
///
///
///
publicstaticvoidMyMethod(intInt1)
{
}
3.3.4单行注释
该类注释用于
1方法内的代码注释。
如变量的声明、代码或代码段的解释。
注释示例:
//注释语句
privateintnumber;
2方法内变量的声明或花括号后的注释,注释示例:
if(1==1)//alwaystrue
{
statement;
}//alwaystrue
3.3.5注释标签
标签
用法
作用
c>text
text希望将其指示为代码的文本。
为您提供了一种将说明中的文本标记为代码的方法。
使用将多行指示为代码
content段落文本。
用于诸如
name为方法参数名。
将此名称用单引号括起来('')。
应当用于方法声明的注释中,以描述方法的一个参数。
name
要引用的参数名。
将此名称用双引号括起来("")。
可以处理XML文件,从而用某种独特的方法格式化该参数。
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后,将member传递给输出XML中的元素名。
必须将member括在双引号("")中。
使您得以从文本内指定链接。
使用
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后,将member传递给输出XML中的元素名。
必须将member括在双引号("")中
使您得以指定希望在“请参阅”一节中出现的文本。
使用
description
代码示例的说明。
使用
一般情况下,这将涉及到标记的使用。
content
content为希望将其标记为代码的文本。
记为您提供了一种将多行指示为代码的方法。
使用
此处description为对象的摘要。
应当用于描述类型成员。
使用
cref="member"对可从当前编译环境中获取的异常的引用。
编译器检查到给定异常存在后,将member转换为输出XML中的规范化元素名。
必须将member括在双引号("")中。
description说明。
filename包含文档的文件名。
该文件名可用路径加以限定。
将filename括在单引号中('')。
Tagpath:
filename中指向标记名的标记路径。
将此路径括在单引号中('')。
name注释前边的标记中的名称说明符;名称具有一个id。
id
位于注释之前的标记的id。
将此id括在双引号中("")。
这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。
有关自定义
term定义的项,该项将在text中定义。
description目符号列表或编号列表中的项或者term的定义。
定义表时,只需为标题中的项提供一个项。
列表中的每一项用
创建定义列表时,既需要指定term也需要指定text。
但是,对于表、项目符号列表或编号列表,只需为text提供一个项。
列表或表所拥有的
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后,将member转换为输出XML中的规范化元素名。
必须将member括在双引号("")中。
description成员的访问的说明。
System.Security.PermissionSet使您得以指定对成员的访问。
description成员的说明。
description返回值的说明。
property-description属性的说明。
请注意,当在VisualStudio.NET开发环境中通过代码向导添加属性时,它将会为新属性添加
然后,应该手动添加
3.4 申明
3.4.1每行声明数
一行只建议作一个声明,并按字母顺序排列。
如
intlevel;//推荐
intsize;//推荐
intx,y;//不推荐
3.4.2初始化
建议在变量声明时就对其做初始化。
3.4.3位置
变量建议置于块的开始处,不要总是在第一次使用它们的地方做声明。
如
voidMyMethod()
{
intint1=0;//beginningofmethodblock
if(condition)
{
intint2=0;//beginningof"if"block
...
}
}
不过也有一个例外
for(inti=0;i { ... } 应避免不同层次间的变量重名,如 intcount; ... voidMyMethod() { if(condition) { intcount=0;//避免 ... } ... } 3.4.5字段的声明 尽量少使用静态变量,除非它是只读的. 不要使用是public或protected的实例字段。 如果避免将字段直接公开给开发人员,可以更轻松地对类进行版本控制,原因是在维护二进制兼容性时字段不能被更改为属性。 考虑为字段提供get和set属性访问器,而不是使它们成为公共的变量。 get和set属性访问器中可执行代码的存在使得可以进行后续改进,如在使用属性或者得到属性更改通知时根据需要创建对象。 下面的代码示例阐释带有get和set属性访问器的私有实例字段的正确使用。 示例: publicclassControl: Component { privateinthandle; publicintHandle { get { returnhandle; } } } 3.5命名规范 3.5.1命名概述 尽量以业务名称来命名,从而实现代码的自注释。 例如,可以使用GetNextStudent(),而不是GetNextArrayElement()。 命名原则是: 以下几点是推荐的命名方法。 1、避免容易被主观解释的难懂的名称,如方面名AnalyzeThis(),或者属性名xxK8。 这样的名称会导致多义性。 2、在类属性的名称中包含类名是多余的,如Book.BookTitle。 而是应该使用Book.Title。 3、和计算有关的变量,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。 4、在变量名中使用互补对,如min/max、begin/end和open/close。 5、布尔变量名应该包含Is,如fileIsFound。 7、即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。 仅对于短循环索引使用单字母变量名,如i或j。 可能的情况下,尽量不要使用原义数字或原义字符串,如 Fori=1To7。 而是使用命名常数,如Fori=1ToNUM_DAYS_IN_WEEK以便于维护和理解。 3.5.2大小写规则 大写 标识符中的所有字母都大写。 仅对于由两个或者更少字母组成的标识符使用该约定。 例如: System.IO System.Web.UI 下表汇总了大写规则,并提供了不同类型的标识符的示例。 标识符 大小写 示例 类 Pascal AppDomain 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChange 异常类 Pascal WebException 注意总是以Exception后缀结尾。 只读的静态字段 Pascal RedValue 接口 Pascal IDisposable 注意总是以I前缀开始。 方法 Pascal ToString 命名空间 Pascal System.Drawing 属性 Pascal BackColor 公共实例字段 Pascal RedValue 注意很少使用。 属性优于使用公共实例字段。 受保护的实例字段 Camel redValue 注意很少使用。 属性优于使用受保护的实例字段。 私有的实例字段 Camel redValue 参数 Camel typeName 方法内的变量 Camel backColor 3.5.3缩写 为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则: 1缩写尽量不要有歧义。 例如,使用GetWindow,而不要使用GetWin。 2不要使用计算机领域或业务领域中未被普遍接受的缩写。 3在适当的时候,使用众所周知的缩写替换冗长的词组名称。 例如,用UI作为UserInterface缩 写,用OLAP作为On-lineAnalyticalProcessing的缩写。 4在使用缩写时,对于超过两个字符长度的缩写请使用Pascal大小写或Camel大小写。 例如,使用HtmlButton或HTMLButton。 但是,应当大写仅有两个字符的缩写,如,System.IO,而不是System.Io。 3.5.4命名空间 1、命名空间时的一般性规则是使用公司名称,后跟系统名称、业务名称,如下所示。 例如: NameSpacePrimax.ESupply.Common 4、命名空间和类不能使用同样的名字。 例如,有一个类被命名为Debug后,就不要再使用Debug作为一个名称空间名。 3.5.5类 1、使用Pascal大小写。 2、用名词或名词短语命名
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 开发 规范 v10