2024年程序员开发手册.docx

《安全生产信息化管理系统》

程序员开发手册

1概述

1.1 目的

1、以便代码的交流和维护。

2、不影响编码的效率，不与大众习惯冲突。

3、使代码更美观、阅读更以便。

4、使代码的逻辑更清晰、更易于理解。

1.2范围

本手册合用于开发部全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。

1.3 警示

通过自动检查【Microsoft.StyleCop】或人工检查【部门主管或有关负责人】不符合编码规范的，必须在限期【部门主管或有关负责人指定期间】内修正,逾期视為工作过錯，部门主管或有关负责人视详细状况做出有关处理。

1.4 术語定义

1、匈牙利命名法【禁用】

标识符的名字以一种或者多种小写字母开头作為前缀；前缀之后的是首字母大写的一种单詞或多种单詞组合，该单詞要指明变量的用途。

例如：aUserId数组(Array)定义以小写字母a开头

2、帕斯卡（pascal）命名法【推荐】

将标识符的首字母和背面连接的每个单詞的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：UserId

3、骆驼(Camel)命名法【推荐】

标识符的首字母小写，而每个背面连接的单詞的首字母都大写。例如：userId

2代码格式

2.1 列宽

1、為了防止在阅读代码時不得不滚动源代码编辑器，每行代码或注释在一般显示频率下不得超过一显示屏，代码列宽控制在110字符左右。

2、系统中部分代码可以不遵照此原则。

如：VIWFormItemDetail[]

3、SQL語句拼接、字符串拼接、函数参数名过長、判断語句过長的代码要遵照以上原则。

2.2 换行

1、当体現式超过或既将超过规定的列宽，一行被分為几行時，通过将串联运算符放在每一行的末尾而不是开头，清晰地表达没有背面的行是不完整的。

StringquerySql=“SELECTProjectId”+“,ProjectTitle”+“FROMProject”

2、每一行上放置的語句防止超过一条。

3、当体現式超过或既将超过规定的列宽，遵照如下规则进行换行

(1)在逗号前换行。

（2）在操作符前换行。

（3）规则1优先于规则2。

例如：

StringBuilderquerySql=newStringBuilder();

querySql.Append(SELECTa.ProjectIdASPK);

querySql.Append(,a.ProjectTitle);

querySql.Append(,a.ProjectDisplayCode);

querySql.Append(,a.IsbnCodeASISBNCode);

querySql.Append(FROMProjecta);

当以上规则会导致代码混乱的時候自已采用更灵活的换行规则。

2.3 缩进

缩进应当是每行一种Tab(4个空格)，不要在代码中使用Tab字符。

VisualStudio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格

2.4 空行

空行是為了将逻辑上有关联的代码分块，以便提高代码的可阅读性。

在如下状况下使用两个空行

1、接口和类的定义之间。

2、枚举和类的定义之间。

3、类与类的定义之间。

在如下状况下使用一种空行

1、措施与措施、属性与属性之间。

2、措施中变量申明与語句之间。

3、措施与措施之间。

4、措施中不一样的逻辑块之间。

5、措施中的返回語句与其他的語句之间。

6、属性与措施、属性与字段、措施与字段之间。

7、注释与它注释的語句间不空行，但与其他的語句间空一行。

2.5 空格

在如下状况中要使用到空格

1、关键字和左括符“(”应当用空格隔开。如

while(true)

注意;在措施名和左括符“(”之间不要使用空格，这样有助于识别代码中的措施调用与关键字。多种参数用逗号隔开，每个逗号后都应加一种空格。

2、除了.之外，所有的二元操作符都应用空格与它們的操作数隔开。一元操作符、++及--与操作数间不需要空格。如

a+=c+d;

a=(a+b)/(c*d);

while(d++=s++)

{

n++;

}

PrintSize(“sizeis“+size+“\n”);

3、語句中的体現式之间用空格隔开。如

for(expr1;expr2;expr3)

4、如下写法是不容許的：

intj=i+k;

2.6 括号-()

1、左括号“(”不要紧靠关键字，中间用一种空格隔开。

2、左括号“(”与措施