1 / 4
文档名称:

软件开发规范:编码规范.doc

格式:doc   大小:59KB   页数:4页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

软件开发规范:编码规范.doc

上传人:aideliliang128 2018/4/23 文件大小:59 KB

下载得到文件列表

软件开发规范:编码规范.doc

文档介绍

文档介绍:C#编码规范
目标:
安全:代码完成所需的功能之余,不要产生负作用,即要稳定可靠。
易读: 类、实例、成员变量、成员函数的命名一目了然
美观: 尽量统一项目组内人员的编程风格。
第一部分:命名
1. 命名原则
所有的函数(变量/类/文件名)应该代表其实际的作用,应该使用有意义的单词或多个词组合,但不要使用人名、项目组名。
所有的函数(变量/类名)一律使用英文。
使用多个单词时不需要使用连线(如下划线), 但对于全部大写的宏需要使用连线。
多个词组合较长时, 可以使用单词的缩写。
不得使用非常相近的名字类表示几个不同含义的函数(变量/类)。
命名时请考虑名字的唯一性和含义的准确性。
使用项目组专用词汇来表达特定的含义(概念), 不得把专用词汇挪作他用。
2. 变量的命名
原则: 使用匈牙利命名法命名变量
变量名一般由“类型修饰+代表变量含意的英文单词或单词缩写”等部分组成。
类型修饰(小写字母):
n: int,l: LONG/long, s: short,u: UINT,f: float
b: bool,by: BYTE,ch: char, sz: char[],str: string
针对异常捕获过程中的 Exception 变量命名,在没有冲突的情况下,统一命名为 e;如果有冲突的情况下,可以重复 e,比如:ee。
3. 函数的命名
使用动宾词组表达函数实际所作的事。
同名的函数(重载函数)在功能上应该完全相同, 在参数上的差别也应一目了然。
不得出现名字非常相近但功能不同的函数. 如 CreatePage1(), CreatePage2()等。
4. 类命名
名字应该能够标识事物的特性。
名字尽量不使用缩写,除非它是众所周知的。
名字可以有两个或三个单词组成,但通常不应多于三个。
在名字中,所有单词第一个字母大写,缩写都要大写。
不要使用下划线字符( _ )。

控件命名=Web控件缩写前缀+ “_”+变量名
控件
Label
TextBox
Button
ListBox
DropDownList
等等
缩写
lb_XXX
tb_XXX
Btn_XXX
Lb_XXX
Drd_XXX
XXXXX
6. 文件命名
文件起名要有实际意义。
,文件名只能包含字母、数字和下划线,不得使用其他的字母。超长的文件名应使用缩写方式减少文件名的长度。建议使用如下的缩写的规则(部分情况可以有例外,视具体情况而定):
缩写一般可以去掉元音字母以及不发音字母
单词的首字母一般应该保留。
当一个单词必须缩成一个字母时,应该选用最有代表性的字母,或首字母。
多音节的单词可以去掉后面的音节而只保留前面的第一、二音节。较短的二音节单词一般不缩写,如果必须缩写,可以只保留一个字母
多个单词组成文件名时,应该保留较重要的有意义的单词(或多留几个字母),其他单词可以使用简写或只用首字母,去掉不必要的无意义的单词
可以使用一些谐音表示一个单词,如 2 表示to,4表示for等等,当单词数量少,字母少的情况下,不需要缩写
较短的单词一般不缩写,或缩写为一到二个字母
第二部分:代码格式书写规范

所有的缩进TAB键

最近更新

基于直觉模糊层次分析法的邯郸市水资源承载力.. 2页

基于生命周期的家庭消费投资效用研究 2页

基于滑膜控制的分数阶时滞混沌系统的同步研究.. 2页

基于水文空间分析的城市滨水绿地生态规划研究.. 2页

基于核心素养提升的数学例题教学探析 2页

基于智能手机的车辆弯道识别与相对定位的研究.. 2页

基于数据驱动的棉织物活性染料上染率模型研究.. 2页

基于收录视角中国地理期刊国际地位分析 2页

基于思维能力培养的少数民族预科数学教学研究.. 2页

基于并联随机共振的弱信号检测研究 2页

基于小波分析的二维结构损伤识别方法应用研究.. 2页

基于大数据系统中国联通公司移动互联网产品策.. 2页

基于复杂贝叶斯网络的安全评估因果量化分析技.. 2页

基于双相介质理论的天然气水合物识别方法研究.. 2页

基于化学主题的综合实践活动设计与实施 2页

基于冲击回波法与支持向量机的预应力管道压浆.. 2页

基于儿童习惯养成教育的有效策略 2页

基于价值链的SL农药集团成本管理研究 2页

基于二元词语搭配的句子情感分类研究 2页

基于“全纳教育”的高校武术教学探索 2页

基于WinCE的大棚温室监测系统的设计 2页

2025年把那株蒲草珍藏于心初中作文(精选10篇.. 16页

2025年把握人生关于高一议论文作文(共17篇).. 29页

2025年技能比武开幕式讲话稿精选(精选14篇).. 27页

2025年技术部岗位职责(共3篇)-大文斗范文网.. 15页

2025年技术员个人工作述职报告-大文斗范文网 10页

2025年承诺读后感600字(集锦16篇) 26页

2025年扬州诗词(推荐12篇) 40页

基于SD的闭环供应链契约协调模型构建及应用研.. 2页

2025年菏泽医学专科学校单招职业技能测试题库.. 72页