程序员开发手册

4.1 每行声明数

一行只建议作一个声明，并按字母顺序排列。如：

14

标记应当用于方法声明的注释，以描述返回值。 《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

int level; //推荐 int size; //推荐 int x, y; //不推荐 4.2 初始化

建议在变量声明时就对其做初始化。 4.3 位置

变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如 void MyMethod() {

int int1 = 0; // beginning of method block if (condition) {

int int2 = 0; // beginning of \"if\" block ... } } 不过也有一个例外

for (int i = 0; i < maxLoops; i++) { ... }

应避免不同层次间的变量重名，如 int count; ...

void MyMethod() {

if (condition) {

int count = 0; // 避免

15

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

... } ... }

4.4 类和接口的声明

1 在方法名与其后的左括号间没有任何空格。

2 左花括号 “{”出现在声明的下行并与之对齐，单独成行。 3方法间用一个空行隔开。

4.5 字段的声明

不要使用是 public 或 protected 的实例字段。如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。考虑为字段提供 get 和set 属性访问器，而不是使它们成为公共的。 get 和 set 属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。下面的代码示例阐释带有get 和 set 属性访问器的私有实例字段的正确使用。示例：

public class Control: Component {

private int handle; public int Handle {

get {

return handle; } }

}

16

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

5 命名规范 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，这意味着 Yes/No 或 True/False 值，如 fileIsFound。

6、在命名状态变量时，避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称，如 documentFormatType。 （此项只供参考） 7、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。 可能的情况下，尽量不要使用原义数字或原义字符串，如

For i = 1 To 7。而是使用命名常数，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。

17

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

5.2 大小写规则

大写

标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：

System.IO System.Web.UI

下表汇总了大写规则，并提供了不同类型的标识符的示例。

标识符 类 枚举类型 枚举值 事件 异常类 只读的静态字段 接口 方法 命名空间 属性 公共实例字段 大小写 Pascal Pascal Pascal Pascal Pascal Pascal Pascal Pascal Pascal Pascal Pascal 示例 AppDomain ErrorLevel FatalError ValueChange WebException 注意 总是以 Exception 后缀结尾。 RedValue IDisposable注意 总是以 I 前缀开始。 ToString System.Drawing BackColor RedValue 注意 很少使用。属性优于使用公共实例字段。 redValue注意 很少使用。属性优于使用受保护的实例字段。 redValue typeName backColor 受保护的实例字段 Camel 私有的实例字段 参数 方法内的变量 5.3 缩写

Camel Camel Camel 为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则： 1 不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 GetWindow，而不要使用 GetWin。

18

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

2不要使用计算机领域中未被普遍接受的缩写。

3在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 缩

写，用 OLAP 作为 On-line Analytical Processing 的缩写。 4在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 HtmlButton 或 HTMLButton。但是，应当大写仅有两个字符的缩写，如，System.IO，而不是 System.Io。 5不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请

使用Camel 大小写，虽然这和单词的标准缩写相冲突。

5.4 命名空间

1、命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。

CompanyName.TechnologyName[.Feature][.Design]

2、命名空间使用Pascal大小写，用逗号分隔开。

3、TechnologyName 指的是该项目的英文缩写，或软件名。

4、命名空间和类不能使用同样的名字。例如，有一个类被命名为Debug后，就不要再使用Debug作为一个名称空间名。 5.5 类

1、使用 Pascal 大小写。 2、用名词或名词短语命名类。

3、使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML 4、不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称 FileStream，而不是 CFileStream。 5、不要使用下划线字符 (_)。

6、有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作

19

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名称 IdentityStore 是适当的。在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因ApplicationException 是一种Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。 public class FileStream public class Button public class String 5.6 接口

以下规则概述接口的命名指南：

1、用名词或名词短语，或者描述行为的形容词命名接口。例如，接口名称 IComponent 使用描述性

名词。接口名称 ICustomAttributeProvider 使用名词短语。名称

IPersistable 使用形容词。

2、使用 Pascal 大小写。 3、少用缩写。

4、给接口名称加上字母 I 前缀，以指示该类型为接口。在定义类/接口对（其中类是接口的标准

实现）时使用相似的名称。两个名称的区别应该只是接口名称上有字

母 I 前缀。

5、不要使用下划线字符 (_)。

6、当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处

只是接口名前有一个I前缀。 以下是正确命名的接口的示例。

public interface IServiceProvider

20

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

public interface IFormatable

以下代码示例阐释如何定义 IComponent 接口及其标准实现 Component 类。 public interface IComponent {

// Implementation code goes here. }

public class Component: IComponent {

// Implementation code goes here.

}

5.7 属性 (Attribute)

应该总是将后缀 Attribute 添加到自定义属性类。以下是正确命名的属性类的示例。

public class ObsoleteAttribute {

}

5.8 枚举 (Enum)

枚举 (Enum) 值类型从 Enum 类继承。 以下规则概述枚举的命名指南：

1、对于 Enum 类型和值名称使用 Pascal 大小写。 2、少用缩写。

3、不要在 Enum 类型名称上使用 Enum 后缀。

4、对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。

5、总是将 FlagsAttribute 添加到位域 Enum 类型。

21

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

5.9 参数

以下规则概述参数的命名指南：

1、使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。

2、对参数名称使用 Camel 大小写。

3、使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。因此，通过描述意义，可以更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它们。

4、不要使用保留的参数。保留的参数是专用参数，如果需要，可以在未来的版本中公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。

5、不要给参数名称加匈牙利语类型表示法的前缀。

6、如果参数用来表述数据表字段内容的，数据类型必须和表字段类型保持一致。

如：UserId为int,不允许作为string类型来传递 以下是正确命名的参数的示例。 Type GetType(string typeName)

string Format(string format, args() As object)

5.10 方法

以下规则概述方法的命名指南： 1、使用动词或动词短语命名方法。

2、返回类型应为数据库数据原始存储的实际类型。比如：BokkType 正确的应为int,如果方法返回的BookType为string,这样的设计不允许，使用的地方根本就不知道返回的BookType到底什么。如果是返回值有不存在的情况，应返回可空的强类型，而不应该返回0表示没有值。 3、使用 Pascal 大小写。 4、以下是正确命名的方法的实例。 RemoveAll()

22

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

GetCharArray() Invoke()

5.11属性 (property)

以下规则概述属性的命名指南： 1、使用名词或名词短语命名属性。

2、返回类型应为数据库数据原始存储的实际类型。 3、使用 Pascal 大小写。 4、不要使用匈牙利语表示法。

5、考虑用与属性的基础类型相同的名称创建属性。例如，如果声明名为 Color 的属性，则属性的类型同样应该是 Color。请参阅本主题中后面的示例。 以下代码示例阐释正确的属性命名。 public class SampleClass {

public Color BackColor {

// Code for Get and Set accessors goes here. } }

以下代码示例阐释提供其名称与类型相同的属性。 public enum Color {

// Insert code for Enum here. }

public class Control

{

public Color Color { Get {

23

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

// Insert code here. } set {

// Insert code here. } } }

以下代码示例不正确，原因是 Color 属性是 Integer 类型的。 public enum Color {

// Insert code for Enum here. }

public class Control {

public int Color {

// Insert code here } }

在不正确的示例中，不可能引用 Color 枚举的成员。Color.Xxx 将被解释为访问一个成员，该成员首先获取 Color 属性（ C# 中为 int 类型）的值，然后再访问该值的某个成员（该成员必须是 System.Int32 的实例成员）。 5.12 事件

以下规则概述事件的命名指南：

1、对事件处理程序名称使用 EventHandler 后缀。

2、指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参数始终是object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装在名为 e 的事件类的实例中。对 e 参数类型

24

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

使用适当而特定的事件类。

3、用 EventArgs 后缀命名事件参数类。 4、考虑用动词命名事件。

5、使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事件后。例如，可以取消的 Close 事件应当具有 Closing 事件和 Closed 事件。不要使用BeforeXxx/AfterXxx 命名模式。

6、不要在类型的事件声明上使用前缀或者后缀。例如，使用 Close，而不要使用 OnClose。

7、通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为 OnXxx）。此方法只应具有事件参数 e，因为发送方总是类型的实例。以下示例阐释具有适当名称和参数的事件处理程序。

public delegate void MouseEventHandler(object sender, MouseEventArgs e);

以下示例阐释正确命名的事件参数类。

public class MouseEventArgs : EventArgs { int x;

int y;

public MouseEventArgs(int x, int y) {

this.x = x; this.y = y; }

public int X { get { return x;

25

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

} }

public int Y {

get {

return y; } } }

5.13 常量 (const)

以下规则概述常量的命名指南：

1、所有单词大写，多个单词之间用 \"_\" 隔开。如： public const string PAGE_TITLE = \"Welcome\"; 2、系统中仅推荐在Const.cs 和 ConstValue.cs 中声明；

3、页面级文件【CNCECHSSE目录下】和【SUBHSSE目录下】中，不能按以上规则命名；

4、其它未说明的地方，使用 Pascal 大小写命名。 5.14 字段

以下规则概述字段的命名指南：

1、private、protected 使用 Camel 大小写。 2、public 使用 Pascal 大小写。

3、拼写出字段名称中使用的所有单词。仅在开发人员一般都能理解时使用缩写。字段名称不要使用大写字母。下面是正确命名的字段的示例。 class SampleClass {

string url;

string destinationUrl;

26

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

}

4、不要对字段名使用匈牙利语表示法。好的名称描述语义，而非类型。 5、不要对字段名或静态字段名应用前缀。具体说来，不要对字段名称应用前缀来区分静态和非静态字段。例如，应用 g_ 或 s_ 前缀是不正确的。 6、对预定义对象实例使用公共静态只读字段。如果存在对象的预定义实例，则将它们声明为对象本身的公共静态只读字段。使用 Pascal 大小写，原因是字段是公共的。下面的代码

示例阐释公共静态只读字段的正确使用。

public struct Color {

public static readonly Color Red = new Color(0x0000FF); public Color(int rgb) {

// Insert code here.}

public Color(byte r, byte g, byte b) {

// Insert code here. }

public byte RedValue {

get

{

return Color; } }

5.15 静态字段

以下规则概述静态字段的命名指南：

1、使用名词、名词短语或者名词的缩写命名静态字段。 2、使用 Pascal 大小写。

3、对静态字段名称使用匈牙利语表示法前缀【不推荐使用，可使用常量命名规则】。

4、建议尽可能使用静态属性而不是公共静态字段。

27

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

5.16 集合

集合是一组组合在一起的类似的类型化对象，如哈希表、查询、堆栈、字典和列表，集合的命名

建议用复数。如： 1、单数型式举列：

审核状态：AuditState 提交类型：PostType 2、复数型式举列：

审核状态：AuditStatus提交类型：PostTypes 5.17 措词

避免使用与常用的 .NET 框架命名空间重复的类名称。例如，不要将以下任何名称用作类名称：

System、Collections、Forms 或 UI。有关 .NET 框架命名空间的列表，请参阅类库。

另外，避免使用和以下关键字冲突的标识符。 AddHandler AddressOf As ByRef Catch Cdec CLng CStr Default Each Erase False Friend Assembly Byte CBool CDbl Cobj Ctype Delegate Else Error Finalize Function Alias Auto ByVal Cbyte Char Const Date Dim ElseIf Event Finally Get And Base Call Cchar Cint Cshort Decimal Do End Exit Float GetType Ansi Boolean Case Cdate Class CSng Declare Double Enum ExternalSource For Goto 28

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

Handles Inherits Lib Mod MyClass Nothing Option Overrides Protected Region Select Single Structure To Until If Integer Like Module Namespace Implements Interface Long MustInherit New Imports Is Loop In Let Me MustOverride MyBase Next Not On Overridable Property ReDim Return Short String Throw Unicode With extends NotInheritable NotOverridable Object Optional ParamArray Public REM Set Static Sub True volatile Or Preserve RaiseEvent Overloads Private ReadOnly RemoveHandler Resume Shadows Step SyncLock Try When Xor var Shared Stop Then TypeOf While Eval WithEvents WriteOnly instanceof package 6 语句

6.1 每行一个语句

每行最多包含一个语句。如： a++; //推荐 b--; //推荐 a++; b--; //不推荐

6.2 复合语句

复合语句是指包含\"父语句{子语句;子语句;}\"的语句，使用复合语句应遵循

29

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

以下几点 1子语句要缩进。

2左花括号“{”在复合语句父语句的下一行并与之对齐，单独成行。 3 即使只有一条子语句要不要省略花括号“ {}”。如： while(d+ = s++) { n++;

}

6.3 return 语句

return语句中不使用括号，除非它能使返回值更加清晰。如： return;

return myDisk.size();

return (size ? size : defaultSize);

6.4 if、 if-else、if else-if 语句 if、 if-else、if else-if 语句使用格式 if (condition) {

statements; }

if (condition) {

statements; } else {

statements; }

30

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

if (condition) {

statements; }

else if (condition) {

statements; } else {

statements; }

6.4 for、foreach 语句 for 语句使用格式

for (initialization; condition; update) {

statements; }

空的 for 语句（所有的操作都在initialization、condition 或 update中实现）使用格式

for (initialization; condition; update); // update user id

foreach 语句使用格式

foreach (object obj in array) {

statements;

31

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

}

注意1在循环过程中不要修改循环计数器。

2对每个空循环体给出确认性注释。

6.5 while 语句 while 语句使用格式 while (condition) {

statements; }

空的 while 语句使用格式 while (condition);

do - while 语句 do - while 语句使用格式 do

{

statements;

} while (condition);

switch - case 语句

switch - case 语句使用格式 switch (condition) {

case 1: statements; break;

32

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

case 2: statements; break;

default: statements; break; } 注意：

1、语句switch中的每个case各占一行。 2、语句switch中的case按字母顺序排列。 3、为所有switch语句提供default分支。

4、所有的非空 case 语句必须用 break; 语句结束。

try - catch 语句

try - catch 语句使用格式 try

{

statements; }

catch (ExceptionClass e) {

statements; } finally {

statements; }

33

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

using 块语句 using 块语句使用格式 using (object) {

statements; }

goto 语句 goto 语句使用格式 goto Label1:

statements; Lable1: statements;

7控件命名规则 7.1 命名方法

控件名简写+英文描述，英文描述首字母大写 7.2 主要控件名简写对照表

【数据类型命名仅供参考，不推荐使用。】 Type Array Boolean Byte Char DateTime Decimal Prefix arr bln byt chr dtm dec 34

Example arrShoppingList blnIsPostBack bytPixelValue chrDelimiter dtmStartDate decAverageHeight 《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

Double Integer Long Object Short Single String WebControls Type dbl int lng obj shr sng str dblSizeofUniverse intRowCounter lngBillGatesIncome objReturnValue shrAverage sngMaximum strFirstName PrefiExample x Prefix Example AdRotator Button adrt adrtTopAd btn btnSubmit _ButtoSubmit_Button n Calendar CheckBox CheckBoxList cal calMettingDates chk chkBlue chkl chklFavColors chkl chklInvoiceState CompareValidator CustomValidator DataGrid DataList valc valcValidAge valx valxDBCheck dgrd dgrdTitles dlst dlstTitles CV CVAddressee valxMailMode Grid InvoiceGrid dlst dlstCollectBill DynamicValidator d DropDownList HyperLink Image ImageButton valvaldColors dcv dcvCustomerName drop dropCountries lnk lnkDetails img imgAuntBetty ibtn ibtnSubmit 35

lnk img ProjectState lnkBooks imgOk _ButtoSave_Button

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

n Label LinkButton ListBox Panel PlaceHolder RadioButton RadioButtonList RangeValidator lbl lblResults lbtn lbtnSubmit lst lstCountries pnl pnlForm2 plh plhFormContents rad radFemale radl radlGender valg valgAge lbl lblTitle lbtn lbtnShow rdol rdolGender RV RVPostCode REVTaxAccount RegularExpressionValidavale valeEmail_ValidatoREV tor Repeater r rpt rptQueryResults rpt RFV tbl rptInvoices RFVAccountBank tblQuery DisCount RequiredFieldValidator valr valrFirstName Table TableCell TableRow TextBox ValidationSummary XML tbl tblCountryCodes tblc tblcGermany tblr tblrCountry txt txtFirstName vals valsFormErrors tblr tblrDisplay CustomerName vals valsFormErrors xmlc xmlcTransformResul ts UpdatePanel ADO.NET 【仅供参考】 Type Connection Command Parameter DataAdapter DataReader UP UPCity Prefix con cmd parm dad dtr 36

Example conNorthwind cmdReturnProducts parmProductID dadProducts dtrProducts

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

DataSet DataTable DataRow DataColumn DataRelation DataView 8页面规范 8.1样式

dst dtbl drow dcol drel dvw dstNorthWind dtblProduct drowRow98 dcolProductID drelMasterDetail dvwFilteredProducts 1、对于多处使用的页面样式要定义。

2、DataGrid、GridView等列表显示中字段值为字符且长度超过6个汉字的，使字段值左对齐；字段值为数字的，使字段值右对齐；除整数外其他含有小数的，一般情况下四舍五入保留2为小数，特殊数字根据实际业务具体处理。

如：折扣输入正整数，印张保留3为小数，材料单位为吨的保留6位小数，为令的保留3位小数，为张的保留1位小数。

3、 DataGrid、GridView4、 DataGrid、GridView

等列表显示中默认每页显示15行。 等列表中的字段标题居中对齐，不换行。

5、 列表页面中输入控件、选择控件、下拉控件尽量保持宽度一致，摆放位

置为左对齐，字段标题居中对齐不换行，字段标题不能两边对齐的，默认右对齐；页面中有字段验证控件的，如果列表中有如：“增加”、“统计”等定位到新页面按钮的，请把此按钮的页面验证去掉，如果验证控件验证数据对按钮执行结果有影响的如：“打印”，需要加验证。 例如：员工姓名为下拉框，在HTML页面中加STYLE。

6、 列表页面中的页面标题居中显示，要和菜单和具体表述的模块或功能保

持一致。

7、 新开发列表模块中使用的控件、样式必须使用系统中存在的最新的，如：

翻页控件；

8、 提交、显示、列表等页面中的日期输入框默认宽度为

70px只读+日期选

择控件；下来选择框默认90px；输入框默认90px；尽量遵循控件左对齐

37

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

和两边对齐的方式。

9、 提交、显示页面中的显示字段，如果字段值不超过

6个汉字的，默认居

中对齐，超过6个汉字的默认左对齐；如：丛书信息有可能超过6个汉字，左对齐。

10、页面数据验证控件的位置和被验证控件的保持同行且不换行，验证控件

如：requiredfieldvalidator的ErrorMessage要和ToolTip保持一致，其它存在此属性的验证控件也按照此方式执行；验证控件提示信息中的标点符号用中文全角。

11、日期格式没有特殊要求的情况下一律默认：yyyy-MM-dd 格式。 12、页面中的冗余代码全部删除。 13、页面中控件的摆放位置需要通过

Table表格去约束此控件所处位置，不

能把多个控件放在同一个TD中且通过
或 去实现位置的摆放。

14、HtmlControl

控件的宽度尽量使用style=”width:90px”去约束而不是

用size=\"6\"。

8.2脚本

1、同种类型的脚本尽量放到同一个位置。

2、脚本中的提示信息的格式要和页面验证控件的提示信息保持一致；如：

提示中的标点符号要使用中文全角。

3、脚本变量、数组、对象、验证、返回值等命名规则同样遵循帕斯卡和骆

驼命名法； 8.3呈现

1、页面中的字段命名尽量和表设计中的字段名称保持一致。

2、对于字段名称和数据表中当成设计字段名称不一致且需要呈现的，如果

有特殊呈现器的，可以借助字段呈现器呈现，如：xx信息SeriesInfo可以命名为：SeriesInfo_SESNAME，尽量不要在.cs中编写代码去实现，便于以后程序维护。

38

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

9其他 9.1 类型转换

1、尽量避免强制类型转换。

2、如果不得不做类型转换，尽量用显式方式。 9.2 错误与提示

1、后台抛出的异常错误页面Wrong.aspx以及JavaScript脚本编写的对数据及操作的错误验证要有返回按钮。 2、权限验证错误页面，要有返回按钮。

3、错误页面的信息提示要简明、扼要，表述客户可以理解的，开发人员明确错误原因的。 9.3代码问题汇总

1. 命名陷阱

从名字看是引导走向A,而实际上引导的方向却是A的相反方向,挖着坑让人跳.

比如：来源于BLL.WholesaleGatheringInfo.cs

bool isPoised = (gg.has.WholesaleGatheringState && gg.WholesaleGatheringState != ST.Poised);

看名字isPoised表示“已冲红”的意思，而继续仔细看代码，却惊奇的发现它表达的是“不是冲红”的意思，如此命名一不小心就引导人犯错误。

2. 偷懒设计

加一个字段就可以解决的问题，却要用另一种危险的设计。

比如：BookStorage

图书库存期初的存储，完全可以在图书库存表加一个字段存储期初值，而目前却在图书库存里单独加一条数据记录来存储期初（用修装数量等于-1来区别）。这样维护困难，还很容易出错，万一修装数量出现-1了怎么办？

39

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

3. 捉迷藏存储

苹果放在存放苹果的地方容易找到，把苹果放到存放西红柿的地方呢？放在大家都熟悉的地方需要的时候才容易找到。 比如：来自PrintFormInfo.cs

方法BookProductionStorageIn表示的是“生产样书单入库”的操作怎么放到印制单操作类里去了，这让同事怎么找？

4. 重复制造轮子

相同功能的相同方法何必重复写，框架提供了经过测试的方法不用。增加维护工作量，还容易产生BUG，轮子已经制造完成就不要再制造重复的。

5. 越描越黑

有问题就要找到问题的根源，彻底解决，而不是绕开问题，大家都绕谁来解决。 比如：

“类别”还有显示值是空的设置项？这是开发人员写的代码把“请选择”存储到数据库里了，导致显示的页面会显示“未知数：0”，正确的应该是把错误存储进数据库的代码修正过来，而不应该在数据里增加这么一项来绕过去，蒙蔽大家的眼睛。

6. 硬代码

这个问题说过很多此，基本上每次开会都强调不允许写硬代码，硬代码产生的错误有时候非常难发现,大量奇怪的问题都是来源于硬代码导致。 比如：Session命名不定义直接引用等

40

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

大量的这类问题。 7、其他未列问题； 10简版要求 10.1 编码要求

1、禁止使用缩写命名,国际通用的除外。 如：不允许把ProjectId命名成pid等。

2、用词要正规，简洁，恰当，不能用汉语拼音,编码风格一致，表达意思易懂。 3、所以源代码文件(二进制文件，版本日志除外)必须以UTF-8带签名格式保存，防止出现乱码情况

4、不允许写硬代码，都在常量类中定义再引用

不允许：if(bk.BookType=1) {

……..

}

推荐： if(bk.BookType=MagicNumber.BOOKTYPE_THEONE)

{

……..

}

5、涉及Sql语句编写的地方如果有参数要传递，必须把Sql语句参数化，防止Sql注入。

不允许：select * from Book where BookName=’张三’ 推荐： select * from Book where BookName=@Bookname,其中

41

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

@Bookname的值为’张三’

6、编写Sql语句时表的别名定义大家都熟悉的名字，读取的列必须限定表前缀,原始列名大小写必须和数据库一样。

错误：Select projectid from Project pj ,Book bk where pj.BookId=bk.BookId

正确： Select pj.ProjectId from Project pj ,Book bk where pj.BookId=bk.BookId

7、代码注释要简洁准确，格式符合要求。

对外公开的方法(类等)： ///

/// 单据Id

/// 单据Model名

/// 触发列名 internal static void CreateGlobalData(int entityId,

string entityTypeName, string trigerColumnName)

{ }

…….

对外公开的变量： ///

internal int TRUESTRING=”True” 局部变量：

int beginIndex=0;//索引开始位置

42

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

/*索引开始位置*/ int beginIndex=0;

8、代码高效，兼容性强.。

使用前先判断是否满足使用条件。

9、功能性代码(界面外的，如某个流程)必须都放在对应的Info文件(BLL)中，不允许在页面(UI)对应的.cs文件中写这些代码，方便自动化测试和代码共享。 10、页面(UI)间不允许相互调用对应.cs文件中的代码。 11、同一个功能的代码不允许在多个地方定义。

12、因日期区域性问题，根据日期生成文件名称时在64位操作系统上会出现问题，如下代码为有问题的：

string

nfn=DateTime.Now.ToString().Replace(\"-\",\"\").Replace(\":\",\"\").Replace(\" \",\"\")+ext;

建议使用时间的滴答数来生成；

13、VS2012中代码格式统一设置。如下图：

在菜单栏中点击工具-选项，找到文本编辑器-HTML-格式，点击标记专用选项。

在标记专用选项的客户端HTML标记中选择要设置的标记

43

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

44

《安全生产信息化管理系统》程序员开发手册

——————————————————————————————————————————————

然后按如下描述设置标记的格式 标记名