word 编码规范测试

修订记录

日期	修订 版本	修改 章节	修改描述	作者
2008-11-27	V1.0	All	初稿完成	云鹏

 

 

 

目  录

第一章         概述................................................................. 7

1.1 目的................................................................................................................................................................ 7

1.2 范围................................................................................................................................................................ 7

1.3 术语................................................................................................................................................................ 7

1.4 代码文件命名组织...................................................................................................................................... 7

1.1.1     代码文件命名.................................................................................................................................... 7

1.1.2     代码文件头注释............................................................................................................................... 8

1.1.3     类头注释............................................................................................................................................ 8

1.1.4     函数头注释........................................................................................................................................ 8

第二章...... 代码外观........................................................................................................................................... 9

2.1 列宽................................................................................................................................................................ 9

2.2 换行................................................................................................................................................................ 9

2.3 缩进................................................................................................................................................................ 9

2.4 空行................................................................................................................................................................ 9

2.5 空格.............................................................................................................................................................. 10

2.6 括号 - ()....................................................................................................................................................... 10

2.7 花括号 - {}................................................................................................................................................... 11

第三章...... 程序注释......................................................................................................................................... 12

3.1 注释概述..................................................................................................................................................... 12

3.2 文档型注释................................................................................................................................................. 13

3.3 类C注释....................................................................................................................................................... 13

3.4 单行注释..................................................................................................................................................... 13

3.5 注释标签..................................................................................................................................................... 13

第四章         声明................................................................. 17

4.1 每行声明数................................................................................................................................................. 17

4.2 初始化.......................................................................................................................................................... 17

4.3 位置.............................................................................................................................................................. 17

4.4 类和接口的声明........................................................................................................................................ 17

4.5 字段的声明................................................................................................................................................. 17

第五章...... 命名规范......................................................................................................................................... 18

5.1 命名概述..................................................................................................................................................... 18

5.2 命名规则..................................................................................................................................................... 18

5.3 缩写.............................................................................................................................................................. 19

5.4 命名空间..................................................................................................................................................... 19

5.5 类.................................................................................................................................................................. 20

5.6 接口.............................................................................................................................................................. 20

5.7 属性类.......................................................................................................................................................... 21

5.8 枚举.............................................................................................................................................................. 21

5.9 参数.............................................................................................................................................................. 21

5.10 方法............................................................................................................................................................ 21

5.11 属性............................................................................................................................................................ 21

5.12 事件............................................................................................................................................................ 22

5.13 常量............................................................................................................................................................ 22

5.14 字段............................................................................................................................................................ 22

5.15 静态字段................................................................................................................................................... 23

5.16 集合............................................................................................................................................................ 23

第六章         语句................................................................. 24

6.1 每行一个语句............................................................................................................................................. 24

6.2 复合语句..................................................................................................................................................... 24

6.3 RETURN 语句............................................................................................................................................... 24

6.4 IF、 IF-ELSE、IF ELSE-IF 语句................................................................................................................... 24

6.5 FOR、FOREACH 语句................................................................................................................................ 25

6.6 WHILE 语句................................................................................................................................................. 25

6.7 DO - WHILE 语句........................................................................................................................................ 26

6.8 SWITCH - CASE 语句................................................................................................................................... 26

6.9 TRY - CATCH 语句....................................................................................................................................... 26

6.10 USING 块语句........................................................................................................................................... 27

6.11 GOTO 语句................................................................................................................................................ 27

第七章...... 控件命名规则............................................................................................................................... 28

7.1 命名方法..................................................................................................................................................... 28

7.2 主要控件名简写对照表........................................................................................................................... 28

 

 

 

关键词： C# 代码 规范

摘  要： 描述采用C#作为开发语言时，代码书写及命名规范，并依据规范制代码CheckList，在代码检视的过程以CheckList作为规范。

缩略语清单：

缩略语	英文全名	中文解释

                                                                                                                                        第一章      概述

1.1  目的

为方便代码的交流和维护，使代码更美观、阅读更方便，从而保证代码的逻辑更清晰、更易于理解的目的，制定本编码规范。

该规范将作为代码编码质量度量和考核的重要标准。

要求开发人员严格遵守该规范进行编码开发。

要求代码检视人员严格遵守该规范对代码检视。

要求质量管理人员严格遵守该规范对代码质量进行度量和考核。

1.2  范围

本文档适用于采用C#作为开发语言的开发人员、代码检视人员和质量管理人员。

1.3  术语

l  Pascal命名法：标识符的首字母和后面连接的每个单词的首字母都大写。例如：GetHostByName()

l  Camel命名法：标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如:getHostByName()

1.4  代码文件命名组织

1.1.1 代码文件命名

l  文件名遵从Pascal命名法，无特殊情况，扩展名小写；

l  使用统一而又通用的文件扩展名： C# 类：*.cs；

l  文件名要求通俗易懂，从而达到通过文件名能够了解该文件所实现的大概功能。

l  文件名中所涉及到用户单词，原则上要求全部写全。文件名长度原则上保持在5~20个字符之间（注：不包括文件扩展名），对于超过20个字符的文件名，可以对部份单词进行缩写。单词缩写时要求遵守业界习惯和日常大多数人所采用的方式。例如：Serv。

1.1.2 代码文件头注释

代码文件头要求都带有注释，样式如下所示:

    /// <summary>

    /// 文件功能描述

    /// <list type="table">

    /// <item>

    /// <term>版权信息</term><description> Copyright (C) 2004 江苏华软联合科技有限公司</description>

    /// <term>文件版本</term><description></description>

    /// <term>文件名称</term><description></description>

    /// <term>作    者</term><description></description>

    /// <term>生成日期</term><description></description>

    /// <term>函数列表</term><description></description>

    /// <term>修改历史</term><description>日期  作者  修改内容</description>

    /// </list>

/// </summary>

1.1.3 类头注释

/// <summary>

/// 功能说明

/// </summary>

/// <code>调用示例</code>

/// <remarks>包括作者,修改记录信息等等</remarks>

1.1.4 函数头注释

/// <summary>                                  

/// 函数功能说明                               

/// </summary>                                 

/// <param name="参数名">参数说明</param>      

/// <param name="参数名">参数说明</param>      

/// <param name="参数名">参数说明</param>      

/// <returns>返回值</returns>                  

/// <code>调用示例</code>                      

/// <remarks>包括作者,修改记录信息等等</remarks>

转载于:https://www.cnblogs.com/MakethingsEasy/archive/2011/12/08/2280679.html