软件开发编码规范.docVIP

软件开发编码规范(C＃)

目录

TＯＣ\ｏ”1—3＂＼ｈ＼zHYPＥRLINＫ＼l”_To1引言＼h4

ＨYＰEＲLINK\l_To1。1编写目的PAＧEREＦ_To\h4

HYPERＬIＮK与for在同一行

}

正确形式:

foｒ(ｉ:=0;i〈10；ｉ＋+）//对,“{”在另外一行中

{

}

注释

通常使用“／*。.。*/”类型的块注释和“／／＂类型的行注释。

语句格式与语句书写规范

括号

?在左括号与下一字符之间没有空格.同样，右括号与前一字符也没有空格。下面的例子演示了正确与不正确的空格。

CallProc（aParaｍeteｒ);//错！?CaｌｌＰroc(aＰarameteｒ)；/／正确！

保留字和关键字

在用户的各种命名中不能单独使用保留字或关键字来进行命名。

函数

格式

函数名要能体现出该函数要实现的功能，应当以大写字母开始,且大小写交错以增加可读性（每个单词的首字母大写）。下面是一个不正确的写法:

pｕbｉlcｖoidｔhisisａpoｏrlｙfｏｒmattedroｕｔiｎenamｅ()

下面是正确的写法:

ｐuｂiｌｃvｏｉｄThｉｓIsMｕｃhＭoｒｅReadaｂlｅRouｔineNaｍe（)

形参

1)参数顺序

?形参的顺序主要要考虑寄存器调用规则.最常用的参数应当作为第一个参数,按使用频率依次从左到右排。输入参数位于输出参数之前。范围大的参数应当放在范围小的参数之前．例如:

SomｅProc（aＰｌａnet，aCｏntinent，aCｏｕntｒy,aSｔaｔe，aCity)．

?有些则例外。例如，在事件处理过程中,Ｏｂjeｃt类型的Sender参数往往是第一个要传递的参数。

２)常量参数

?任何值类型参数，只要不加REF标志，都是常量参数；

任何引用类型参数，都不是常量参数，不管加不加标志。

变量

局部变量

?局部变量用于过程内部，如果需要的话,应当在过程的入口处立即初始化变量。

全局变量

?一般不鼓励使用全局变量.不过，有时候需要用到。即使如此,也应当把全局变量限制在需要的环境中。例如,一个全局变量可能只在单元的实现部分是全局的。

?全局数据如果将由许多单元使用,就应移动到一个公用单元里被所有对象使用。全局数据可在声明时直接初始化为一个值。

语句

If语句

?在iｆ/eｌse语句中,iｆ子句的条件应该直接且易于理解。为了避免出现许多if语句，可以使用switｃｈ语句代替。如果多于5级,不要使用if语句。请改用更清楚的方法。

?如果在if语句中有多个条件要测试，应按照计算的复杂程度从右向左排。这样，可以使代码充分利用编译器的短路估算逻辑.例如,如果Coｎdｉtioｎ１比Coｎdition2快，Ｃｏｎdｉtｉon2比Cｏnｄition３快,则if语句一般应这样构造：

if（Ｃonｄｉｔiｏn1Ｃoｎditioｎ2＆Condｉtion３）

?如果Condｉtiｏn3为False的机会很大，利用短路估算逻辑，我们也可以将Conditiｏｎ3放在最前面：

iｆ(Condｉtiｏn3＆Conditｉon１Ｃondｉtioｎ2）

有ｉf出现,就必须有对应的ｅlse出现。ｉf语句的三种形式：

形式一(不需要else)

if（Coｎｄitｉon)

{

Proceｓs；

}

//else

//{

／/NoElseＮeeｄed

//}

形式二(需要eｌse，但是else里面不需要处理)

iｆ(Cｏndｉtion)

{

Proceｓｓ；

｝

ｅlse

{

//NoNｅｅdＰｒocesｓ

｝

形式三（if里面不需要处理）

ｉf（Conditioｎ)

｛

／/NoNeｅdＰrｏｃess

}

else

｛

Pｒocｅsｓ;

}

switch语句

1)概述

?switcｈ语句中每种情况的常量应当按数字或字母的顺序排列。每种情况的动作语句应当简短且通常不超过4—5行代码。如果动作太复杂，应将代码单独放在一个函数中。swｉtch语句的ｅｌse子句只用于默认情况或错误检测.

２）格式

?switｃh语句遵循一般的缩进和命名规则。

while语句

?所有对ｗｈｉle循环进行初始化的代码应当位于wｈiｌe入口前,且不要被无关的语句隔开.任何业务的辅助工作都应在循环后立即进行。

ｆoｒ语句

如果循环次数是确定的,应当用foｒ语句代替wｈiｌｅ语句。

命名规范

函数命名

?函数名应当有意义.进行一个动作的函数最好在名称前加上表示动作的动词