- 1、本文档共15页,可阅读全部内容。
- 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
文档编号
文档编号
版本
1.0
密级
本部门开放
工作规
共 15 页
软件开发代码规(C#版)
拟制: 日期:
审核: 日期:
审核: 日期:
批准: 日期:
所有 ********
2007-2-13
修订纪录
日期
修订版本
描述
作者
2007-2-13
1.00 初稿完成
2007-5-10
1.01 修正
2007-11-2
1.02 修正
目 录
1、 第一章 命名规 4
、 第一节 总则 4
、第二节 变量命名规 4
、CodeBehind 部命名规 4
、控件命名规 5
、第三节 常量命名规 5
、第四节 命名空间、类、方法命名规 5
、第五节 接口命名规 6
、第六节 命名规小结 6
2、第二章 代码注释规 6
、第一节 模块级注释规(命名空间、类等) 6
、第二节 方法级注释规 7
、属性注释 7
、方法注释 7
、第三节 代码间注释规 8
3、第三章 编写规 9
、第一节 格式规 9
、第二节 编程规 9
、程序结构要求 9
、可读性要求 10
、结构化要求 10
、正确性与容错性要求 10
、可重用性要求 11
、interface 使用注意事项 11
、类使用注意事项 11
、流程控制语句注意事项 12
3.2.8 、其他应注意事项 13
注:Pascal 命名法则:即名称中所有单词的第一个字母大写其他字母使用小写形式。
Camel 命名法则:即名称中第一个单词各个字母全部小写,其他部分遵循 Pascal 命名法则。
1、第一章 命名规
、第一节 总则
本命名规则除特殊提及外统一使用 Camel 命名法则。如:controlMenu
命名时尽量不使用拼音,更不可使用拼音缩写(专有名词除外)。
如果使用品牌名称命名时其大小写尽量保持和品牌名称一致的样式。
如:LuX 则命名时,不要写成LUX,或者Lux,而应该保持与原品牌名称风格一致使用 LuX
使用专有名词或英文缩写命名时采用大写形式。如:CNNIC
禁止使用仅区分大小写的方式命名。
如:Abc 与 abc 仅用大写 A 来区分,这样写在类 C 系语言中不会出错,但是不利于系统的迁移
、第二节 变量命名规
、CodeBehind 部命名规
公有字段/属性使用 Pascal 命名规则,私有变量/保护变量/局部变量使用 Camel 命名规则,遵循动宾结构。
例:
public class Hello
{
private string userName; private DateTime loginTime; private bool isOnline;
public string UserName {
get { return this.userName; }
}
}
即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用意义描述性的名称。仅对于短循环索引使用单字母变量名,如 i 或 j
在变量名中使用互补对,如 Min/Max、Begin/End 和 Open/Close。4.当一个方法部变量繁多的时候,可以使用Camel 命名法则,其中第一个单词可以使
用变量类型的缩写来说明以示区别。例:
string strName; int intAge; object objPerson;
、控件命名规
控件缩写声明
控件
缩写
声明
Label
lbl
protected Label lblName;
TextBox
txt
protected TextBox txtContent;
CheckBox
chk
protected CheckBox chkRight;
Button
btn
protected Button btnOK;
ListBox
lbx
protected ListBox lstItem;
DropDownList
ddl
protected DropDownList ddlArea;
etc.
、第三节 常量命名规
常量名也应当有一定的意义,格式为 NOUN 或 NOUN_VERB。常量名均为大写,字之间用下划线分隔。
例:
private const bool WEB_ENABLEPAGECACHE_DEFAULT = true; private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT = 3600;
private const bool WEB_ENABLESSL_DEFAULT = false;
注:
变量名和常量名最多可以包含 255 个字符,但是,超过 25 到 30 个字符的名称比较笨拙。此外,要想取一个
您可能关注的文档
- 人教版小学英语三四五六年级上下册词汇默写汇总(打印版).docx
- 人教版新起点一年级英语下册《Unit 6 Clothes》教案.docx
- 人教版一年级新起点英语下册教案.docx
- 人教部编版小学语文四年级下册第10课《绿》教学设计.docx
- 人教精通版英语三年级下册学期计划.docx
- 人音版八年级下册音乐精品教案(版本).docx
- 人音版小学三年级音乐下册教案全册.doc
- 如何培养幼儿整理物品的能力.docx
- 如何确定轻杆上弹力方向.docx
- 软件项目或软件产品的度量.docx
- 英语人教PEP版八年级(上册)Unit4+writing+写作.pptx
- 人美版美术四年级(上册)8 笔的世界 课件 (1).pptx
- 人美版美术七年级(上册)龙的制作.pptx
- 英语人教PEP版六年级(上册)Unit 2 第一课时.pptx
- 数学苏教版三年级(上册)3.3 长方形和正方形周长的计算 苏教版(共12张PPT).pptx
- 音乐人教版八年级(上册)青春舞曲 课件2.pptx
- 音乐人教版四年级(上册) 第一单元 音乐知识 附点四分音符|人教版.pptx
- 英语人教PEP版四年级(上册)Unit 6 Part B let's learn 1.pptx
- 道德与法治人教版二年级(上册)课件-3.11大家排好队部编版(共18张PPT).pptx
- 人美版美术七年级(上册)《黄山天下奇》课件1.pptx
最近下载
- 耳鼻喉科术后感染预防PDCA循环案例.pptx VIP
- 干部管理-华为学习材料.pdf VIP
- 华为干部管理七步曲.pdf VIP
- 外研版小学五年级英语上册《Module 5 Unit 1 There are only nineteen crayons 》教学教案.doc VIP
- 2018年春二年级下册道法教案.pdf VIP
- 高中体育新课标程准考试试题.doc VIP
- 甲亢甲减的相关知识与护理PPT课件.pptx VIP
- 新人教pep三年级上册Unit2 Different families PartA talk &learn 课件.ppt
- 九年级化学培优辅差工作总结 .pdf VIP
- 第4课《古代诗歌四首》核心素养教学设计-七年级语文上册(统编版).docx
文档评论(0)