想求C#的代码编写规范

dibov 2003-10-16 11:12:13
同上
...全文
50 17 打赏 收藏 转发到动态 举报
写回复
用AI写文章
17 条回复
切换为时间正序
请发表友善的回复…
发表回复
dibov 2003-10-24
  • 打赏
  • 举报
回复
thanks very much!
meetweb 2003-10-21
  • 打赏
  • 举报
回复
引用二: 方法开头的注释模板
/*****************************************************************
** 方法名:
** 输 入: a,b,c
** a---
** b---
** c---
** 输 出: x---
** x 为 1, 表示...
** x 为 0, 表示...
** 功能描述:
** 全局变量:
** 调用模块:
** 作 者:
** 日 期:
** 修 改:
** 日 期:
** 版本
****************************************************************/
引用三: 程序中的注释模板
/*----------------------------------------------------------*/
/* 注释内容 */
/*----------------------------------------------------------*/

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


Variable definition :

Variable type Definition way

1. String str + Xxx

2. Integer int + Xxx

3. Long lng + Xxx

4. Object obj + Xxx

5. Array arr + Xxx

6. Double dbl + Xxx

7. Single sgl + Xxx

8. Boolean bln + Xxx

9. DataSet ds + Xxx

10. SqlDataReader dr + Xxx

12. SqlDataAdapter da + Xxx

13. SqlCommand comm + Xxx

14. SqlConnection conn + Xxx

15. SqlTransaction Tran + Xxx

16. FileStream fs + Xxx

17. BinaryWriter bw + Xxx

18. Exception ep + Xxx

19. SqlParameter para + Xxx

20. DataTable dt + Xxx

21. DataRow dr + Xxx

22. DataColumn dc + Xxx

23. BinaryReader br + Xxx

24. Collection col + Xxx

25. DataGrid dg + Xxx

26. DataGridColumn dgc + Xxx

27. DataGridItem dgi + Xxx
页面控件命名规则



控件名 控件命名 例子


Label lbl + Field Description lblSupplierCode


RadioButtonList rad + Field Description radActive


TextBox txt + Field Description txtSupplierName


DropDownListBox drp + Field Description drpSupplierGroup


ListBox lst + Field Description lstSupplier


Button btn + Field Description btnSave


ImageButton img + Field Description imgSupplier


DataGrid dg + Description dg_searchResult


CheckBox chk + Field Description chkMon
I. Naming convention

0. General

0. Nouns are in single
1. No abbreviation

1. Variable names in HTML and Database & file/program names

1. All in lower case
2. Words are separated by "_"
3. Variable names in HTML and database should be the same if they mean the same thing.
meetweb 2003-10-21
  • 打赏
  • 举报
回复
例如:

try

{

}

catch

{

}

finally

{

}


5. 可重用性要求
5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
5.2 公共控件或类应考虑OO思想,减少外界联系,考虑独立性或封装性。
5.3 公共控件或类应建立使用模板。


1适用范围

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

2变量命名

命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意
义字符串,如果连续意义字符串仅两个,可都大写.如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常量命名
常量定义必须具有一定的实际意义;

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

4资源名字定义格式:
菜单: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类库统一,分WindowsForm程序和Web程序(也许大家不是很习惯J).

WindowsForm程序

用小写前缀表示类别

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

Web程序

用大写前缀表示类别

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

8注释
原则上注释要求使用中文;
文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复
杂的算法需要加上流程说明;
方法注释包括:输入、输出、方法描述、流程处理、全局变量、调用样例等,复杂的函数
需要加上变量用途说明;
程序中注释包括:修改时间和作者、方便理解的注释等;
引用一: 文件开头的注释模板
/******************************************************************
** 文件名:
** Copyright (c) 1998-1999 *********公司技术开发部
** 创建人:
** 日 期:
** 修改人:
** 日 期:
** 描 述:
**
** 版 本:
**----------------------------------------------------------------------------
******************************************************************/
meetweb 2003-10-21
  • 打赏
  • 举报
回复
C# 编程规范
1.基本要求
1.1 程序结构清析,简单易懂,单个方法的程序行数不得超过100行。每个方法应该且只应该完成一件事情,方法不应该有副作用。


1.2 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
1.3 尽量使用标准库和公共方法。
1.4 不要随意定义全局变量,尽量使用局部变量。
1.5 使用括号以避免二义性。

2.可读性要求
2.1 可读性第一,效率第二。
2.2 保持注释与代码完全一致。
2.3 每个源程序文件,都有文件头说明,说明规格见规范。
2.4 每个方法,都有方法头说明,说明规格见规范。
2.5 主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。
2.7 常量定义(DEFINE)有相应说明。
2.8 处理过程的每个阶段都有相关注释说明。
2.9 在典型算法前都有注释。
2.10 利用缩进显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为4个字节。
2.11 循环、分支层次不要超过五层。
2.12 注释可以与语句在同一行,也可以在上行。
2.13 空行和空白字符也是一种特殊注释。
2.14 一目了然的语句不加注释。
2.15 注释的作用范围可以为:定义、引用、条件分支以及一段代码。
2.16 注释行数(不包括程序头和方法头说明部份)应占总行数的 1/5 到 1/3 。
3. 结构化要求
3.1 禁止出现两条等价的支路。
3.2 禁止GOTO语句。
3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
3.4 用 CASE 实现多路分支。
3.5 避免从循环引出多个出口。
3.6 方法只有一个出口。
3.7 不使用条件赋值语句。
3.8 避免不必要的分支。
3.9 不要轻易用条件分支去替换逻辑表达式。
4.10 不要轻易使用递归算法,尤其在访问数据库的时候。

4. 正确性与容错性要求
4.1 程序首先是正确,其次是优美
4.2 无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。
4.3 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。
4.4 所有变量在调用前必须被初始化。
4.5 对所有的用户输入,必须进行合法性检查。
4.6 不要比较浮点数的相等,如: 10.0 * 0.1 == 1.0 , 不可靠
4.7 程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等。对于明确的错误,要有明确的容错代码提示用户。
4.8 单元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。
4.9 尽量使用规范的容错语句.
dibov 2003-10-21
  • 打赏
  • 举报
回复
看别人的例子,有的前面加txt,btn,有的不加,感觉有点乱!
lbywyj 2003-10-16
  • 打赏
  • 举报
回复
比如:
using ...
using ...

namespase
{
public class YourClass
{
//定义你的变量
public YourClass()
{
初始化你的变量
}
//定义你的方法
}
public static void Main()
{
Application.run(new YourClass());
}
}

还能有什么规范呢?
lbywyj 2003-10-16
  • 打赏
  • 举报
回复
在网上找些例子看吧,
其实什么是规范啊?无非是面向对象的思想而已
jhfmail 2003-10-16
  • 打赏
  • 举报
回复
它说是不用了,可是你看它给的例子,文本框仍然加txt,按钮依然是加btn
wangjun99212 2003-10-16
  • 打赏
  • 举报
回复
up
ffb 2003-10-16
  • 打赏
  • 举报
回复
微软推荐的C#规范竟然说不用匈牙利命名方法了,
比如原来的
long lngCount;
微软推荐现在直接使用变量的意义:
long Count;
viaboy 2003-10-16
  • 打赏
  • 举报
回复
study
dahuzizyd 2003-10-16
  • 打赏
  • 举报
回复
http://www.csdn.net/Develop/Read_Article.asp?Id=18528
问道er 2003-10-16
  • 打赏
  • 举报
回复
mark!
zhbname 2003-10-16
  • 打赏
  • 举报
回复
up
amitabha 2003-10-16
  • 打赏
  • 举报
回复
呵呵,一楼是不是还没入门?编程规范跟面向对象有啥关系啊?

楼主,我们项目小组倒是有一份,不过是别人写的,我不好意思向他要啊
wideroad 2003-10-16
  • 打赏
  • 举报
回复
msdn尚有一篇文章就说这个的,你搜以下试一试
dibov 2003-10-16
  • 打赏
  • 举报
回复
一个项目组想统一开发,使其有更好的可读性,应该会统一其代码编写的规则的.
编写规则和面象对像的思想应该还是有区别的.

110,502

社区成员

发帖
与我相关
我的任务
社区描述
.NET技术 C#
社区管理员
  • C#
  • Web++
  • by_封爱
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告

让您成为最强悍的C#开发者

试试用AI创作助手写篇文章吧