C#编程规范 (转载)

转载 2004年08月19日 15:33:00

C#编程规范

为了保证大家使用C#编程和C++的风格的连贯,我在C++的标准备上对C#编程规则作了制定(试用版)

基本要求
1
程序结构要求
1.1
程序结构清晰,简单易懂,单个函数的程序行数不得超过100行。
1.2
打算干什么,要简单,直截了当,代码精简,避免垃圾程序。
1.3
尽量使用.NET库函数和公共函数(无特殊情况不要使用外部方法调用windows的核心动态链接库API)
1.4
不要随意定义全局变量,尽量使用局部变量。
2.
可读性要求
2.1
可读性第一,效率第二(代码是给人读的J)
2.2
保持注释与代码完全一致。
2.3
每个源程序文件,都有文件头说明,说明规格见规范。
2.4
每个函数,都有函数头(使用XML注释)说明,说明规格见规范。
2.5
主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。
2.6
处理过程的每个阶段都有相关注释说明。
2.7
在典型算法前都有注释, 同时算法在满足要求的情况下尽可能简单。
2.8
利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab 4个字节。
2.9
循环、分支层次不要超过五层。
2.10
注释可以与语句在同一行,也可以在上行。
2.11
空行和空白字符也是一种特殊注释。
2.12
一目了然的语句不加注释。
2.13
注释的作用范围可以为:定义、引用、条件分支以及一段代码。
2.14
注释行数(不包括程序头和函数头说明部份)应占总行数的 1/5 1/3

 

3. 结构化要求

3.1
禁止出现两条等价的支路。
3.2
除了在Switch关键字的作用域内,禁止GOTO语句。
3.3
IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO ELSE RETURN
3.4
CASE 实现多路分支。
3.5
避免从循环引出多个出口。
3.6
函数只有一个出口。
3.7
不使用条件赋值语句。
3.8
避免不必要的分支。
3.9
不要轻易用条件分支去替换逻辑表达式。

 

4. 正确性与容错性要求

4.1
程序首先是正确,其次是优美
4.2
无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。
4.3
改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。
4.4
所有变量在调用前必须被初始化。
4.5
对所有的用户输入,必须进行合法性检查。
4.6
尽量不要比较浮点数的相等,
如: 10.0 * 0.1 == 1.0 不可靠
4.7
程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等,对于明确的错误,要有明确的容错代码提示用户,在这样不确定的场合都使用Try Throw Catch
4.8
单元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。

4.9 尽量使用规范的容错语句.

  例如:

try

{

}

catch

{

}

finally

{

}

5. 可重用性要求

5.1
重复使用的完成相对独立功能的算法或代码应抽象为asp.net服务或类。
5.2asp.net
服务或类应考虑OO思想,减少外界联系,考虑独立性或封装性。

 

附:C#编程规范

1适用范围

本标准适用于利用Visaul C# ,其余语言作参考.

2变量命名

命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,AbcFgh表示连续意
义字符串,如果连续意义字符串仅两个,可都大写.OK.

具体例程:

BOOL
类型    bEnable;

sz   char     szText

sb   sbyte     sbText

bt    byte     btText

n     int      nText

ui    uint      uiText

l     long     lText

ul    ulong    ulText

f     float     fText

d    double    dText

b    bool      bText

de   decimal   deText

str   string     strText

x,y 坐标

att   表属性

m_ 类成员变量 m_nVal, m_bFlag

s_  类静态成员变量 s_nVal,s_bFlag

//不提议用全局变量,其于类的实例,尽量选取表示该类特性的字母,例如classText,class体现类的特性.

3常量命名和宏定义

常量和宏定义必须具有一定的实际意义;

常量和宏定义在#include和函数定义之间;

常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一
条定义的右侧必须有一简单的注释,说明其作用;

4资源名字定义格式(我对.NET的资源还没有了解的多),只写几个:
菜单:IDM_XX或者CM_XX
位图:IDB_XX
对话框:IDD_XX
字符串:IDS_XX
DLGINIT:DIALOG_XX
ICON:IDR_XX

5函数命名和命名空间,类的命名,接口的命名
函数原型说明包括引用外来函数及内部函数,外部引用必须在右侧注明函数来源:
块名及文件名, 如是内部函数,只要注释其定义文件名;
第一个字母必须使用大写字母,要求用大小写字母组合规范函数命名,必要时可用下划线
间隔,示例如下:

void PrintTrackData ( );

void ShowChar (int , int ,char);

事件函数的命名:

   void EventH(object sd,Event e)  //Event 表示事件响应的函数.

接口的命名

   接口的命名一般都以’I’作为首字母,为了和类区分,例如:

     interface IA 

命名空间(例如 namespace A)和类的命名规则从原则上和函数命名相同.

 

6结构体命名
结构体类型命名必须全部用大写字母,原则上前面以下划线开始;结构体变量命名必须用
大小写字母组合,第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数
据区,必须注明其所属的进程。全局数据定义只需注意其用途。

示例如下:
typedef struct
{
char szProductName[20];
char szAuthor[20];
char szReleaseDate[16];
char szVersion[10]; 
unsigned long MaxTables;
unsigned long UsedTables;
}DBS_DATABASE;
DBS_DATABASE GdataBase;

7 控件的命名:

C#控件规则为了和.net类库统一,Windows Form程序和Web程序(也许大家不是很习惯J).

Window Form程序

   用小写前缀表示类别

        fm 窗口
cmd
按钮
cob combo
,下拉式列表框
txt
文本输入框
lab labal
,标签
img image
,图象
pic picture
grd Grid
,网格
scr
滚动条
lst
列表框
frm fram

Web程序

   用大写前缀表示类别

        Fm 窗口
Cmd
按钮
Cob combo
,下拉式列表框
Txt
文本输入框
Lab labal
,标签
Img image
,图象
Pic picture
Grd Grid
,网格
Scr
滚动条
Lst
列表框
Frm fram

8注释

原则上注释要求使用中文;
文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,
杂的算法需要加上流程说明;
函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数
需要加上变量用途说明;
程序中注释包括:修改时间和作者、方便理解的注释等;
引用一: 文件开头的注释模板
/******************************************************************
**
文件名:
** Copyright (c) *********
东南大学灵感工作室
**
创建人:
**
:
**
修改人:
**
:
**
:
**
**
:
**----------------------------------------------------------------------------

 

引用二: 函数开头的注释模板

/// <summary>

         ///

         /// </summary>

         /// <param name=""></param>

         /// <param name=""></param>

/// <author></author>

/// <date></date>

/// <version></version>

引用三: 程序中的注释模板
/*----------------------------------------------------------*/
/*
注释内容 */
/*----------------------------------------------------------*/

9 程序
a.
程序编码力求简洁,结构清晰,避免太多的分支结构及太过于技巧性的程序,
尽量不采用递归模式。
b.
编写程序时,亦必须想好测试的方法,换句话说,单元测试的测试方案应
在程序编写时一并拟好。
c.
注释一定要与程序一致。
d.
版本封存以后的修改一定要将老语句用/* */ 封闭,不能自行删除或修改,并要
在文件及函数的修改记录中加以记录。
e.
程序中每个block 的开头 ”{" "}” 必须对齐,嵌套的block 每进一套,
缩进一个tabTAB 4个空格,block类型包括ifforwhiledo等关键字引出的。
f.
对于比较大的函数,每个block 和特殊的函数调用,都必须注明其功能.

 

 

[连载]C#程序设计(03)--- C#核心编程-1 --- Hello, world!

一个简单的C#程序   System.Environment类   System.Console类   系统数据类型和C#简化符号   使用字符串   数据类型转换   循环和分支结构   方法和参数...
  • jackfrued
  • jackfrued
  • 2014年02月26日 23:20
  • 1441

Windows核心编程:(一)内核对象

一:何为内核对象       每个内核对象都只是一个内存块,它由操作系统内核分配,并只能由操作系统内核访问。这个内存块是一个数据结构,其成员维护着与对象相关的信息。 二:使用计数 ...
  • Windows_and_Linux
  • Windows_and_Linux
  • 2015年03月11日 11:13
  • 426

编程原则

极限编程实践作业的核心可以被区分为以下四个范围(12个实践作业): 小规模回馈 测试驱动开发 策划游戏 全队(原名:在场客户) 结对程序设计 反复性程序而不是批量的 持续集成 设计优化(原名:软...
  • jfj545
  • jfj545
  • 2014年12月26日 18:33
  • 266

C编程问题精粹

第一章:前言  对于c语言,有人认为它已经落伍了.对于这个问题,仁者见仕,智者见智.的确,c++比c有更强大的诸多优势.但c++是建立在c之上的.这也是herbert schildt所著的 现结合个人...
  • sin4x
  • sin4x
  • 2001年08月22日 16:03
  • 515

面向对象六大原则----开闭原则

Java 中面向对象编程六大原则: 单一职责原则 英文名称是Single Responsibility Principle,简称SRP 开闭原则 英文全称是Open Close Principl...
  • Jo__yang
  • Jo__yang
  • 2016年07月27日 17:59
  • 2859

设计原则之开闭原则

开闭原则,宗旨是对扩展开放、对修改关闭。
  • u012055921
  • u012055921
  • 2017年04月05日 17:33
  • 287

编程原则

编程原则          刚看见数据结构与程序设计这本书时就让我产生了恐惧感,因为都是英文版的读起来很费劲,同时也意识到自己英语水平的低下,感觉学起来会很吃劲,有很多生词需要查,还好本书有...
  • u011747743
  • u011747743
  • 2013年08月21日 20:30
  • 329

程序员必备的七大面向对象设计原则(一)

花絮         每天都在和面向对象打交道,但是我们在应用面向对象的时候感觉自己的面向对象技术应用的很合理?理解的很到位?应用的很到位?用的时候恰到好处?用的是否符合软件的发展趋势?     ...
  • y_xianjun
  • y_xianjun
  • 2012年06月04日 22:11
  • 376

面向对象编程的六大原则

要让自己写的代码有质量,特别是对于面向对象编程的话,代码以及框架的是否合理直接决定了你的程序是否可以良好的扩展和壮大,这在软件工程中也多少学过一点,简单来说就是要做到低耦合高内聚,经过编程人员多年的总...
  • zcxwww
  • zcxwww
  • 2016年05月15日 01:17
  • 1024

《Python核心编程》 第3版 中文版pdf

下载地址:网盘下载 内容简介 编辑 Python是一种功能十分强大的面向对象编程语言,可以用于编写独立程序、快速脚本和复杂应用的原型。作为一种开源软件,Python可以自由获取,而且非常易...
  • cf406061841
  • cf406061841
  • 2017年05月13日 00:03
  • 7333
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:C#编程规范 (转载)
举报原因:
原因补充:

(最多只允许输入30个字)