C#代码的规范

身为一个程序员,如果要想写出好的程序,就一定要是写出好的代码,我们就要明白书写代码的规范。为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范,保证代码的一致性,便于交流和维护,特制定此规范。

标准注释

关于代码注释我之前的理解一直以为只是简单的代码的注解,然后我发现注释不仅仅有对代码注解这一种作用,下面我介绍一下注释的三种用途:
在模块、类、属性、方法前一行添加注释,以便调用的时候提示用户
下以方法声明做例子:
///
///depiction:<对该方法的说明>
///
///<paramname="<参数名称>"><参数说明>
///
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
///
如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:
///修改人:
///修改日期:
///备份:
/原代码内容/
将原代码内容注释掉,然后添加新代码使用以下注释:
///添加人:
///添加日期:
代码内容
///结束:
对于重构的类文件,需要对原来的类文件做备份,然后放在同级目录下,在原有文件名
后面添加后缀"_BAK",以便日后版本升级时整理源码。

命名规则

名字应该能够标识事物的特性,并且与业务挂钩。
名字一律使用英文单词,而不能为拼音。
名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
在具体任务开发中,如果有特定的命名约定,则在相应的软件开发计划中予以明确定义
及上报质量管理部审计组。
以下几点是推荐的命名方法。
Pascal命名法:所有单词的首字母都大写,其他字母小写
Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写
在类属性的名称中包含类名是多余的,如Book.BookTitle。而是应该使用Book.Title。
在变量名中使用互补对,如min/max、begin/end和open/close。
布尔变量名应该包含Is,这意味着Yes/No或True/False值,如fileIsFound。
即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。
仅对于短循环索引使用单字母变量名,如i或j。
文件名要和类名相同,一般情况下一个类一个文件,文件名遵从Pascal命名法,无特
殊情况,扩展名小写,使用统一而又通用的文件扩展名:C#类.cs。

发布了64 篇原创文章 · 获赞 15 · 访问量 7251

猜你喜欢

转载自blog.csdn.net/weixin_42263618/article/details/103846829