程序员应该关注的基本知识（一）——.net代码规范

淡淡的烟草味﹌ 2023-06-27 08:51 36阅读 0赞

# 一、前言 #

不管在什么行业，在任何时候都离不开规范，而这种规范能给我们带来什么?作为一个程序员，通过自己的项目实践，写文档，看资料等学习，知道了这种所谓的规范能给我们带来什么和将会怎样？下面是小编在学习完.net之后对代码规范的一些认识。

# 二、代码规范的意义 #

其实对一个小白来说刚开始编程对很多规范都不知道，编程的时候可能都是照葫芦画瓢，到最后自己也不知道自己写的是什么，比如说方法名，命名，函数之类的该怎么写。但是如果在编程的时候这些动懂将会怎样，将自己认为的好处分享给大家。

## 1.好处 ##

**规范的代码可以促进团队合作**

**规范的代码可以减少bug处理 **

**规范的代码可以降低维护成本**

**规范的代码有助于代码审查 **

**养成代码规范的习惯，有助于程序员自身的成长**

**提高源程序的可读性和可维护性**

# 三、部分注意点 #

## 1.规范的形式 ##

原则：编程时应该坚持的指导思想。

规则：编程时必须遵守约定

建议：编程时必须考虑的约定

## 2.基本内容 ##

**①原则**

**（1）首先为人编写程序，其次是计算机**

**（2）简明清晰，避免过分编程技巧**

**（3）代码尽可能遵循ANSIC标准**

**（4）首先考虑正确性，其次考虑效率**

**（5）避免或少用全局变量等。**

**②布局**

**（1）遵循统一的布局顺序来书写头文件**

常量定义

全局宏

全局数据类型

类定义

模板

**（2）采用统一的布局顺序来书写实现文件**

**（3）使用注释块分离上面的定义的节**

**（4）头文件必须避免重复包含**

**（5）包含标准库头文件用尖括号<>**

**（6）程序中一行的代码和注释不能超过80列**

**（7）相关的赋值语句等号对齐**

**（8）不同的逻辑块之间用空行分隔**

## ③注释 ##

程序块的注释常采用"/\*…\*/"，行注释一般采用"//…"。注释通常用于：

（2）函数接口说明；

（3）重要的代码行或段落提示。

(4) 虽然注释有助于理解代码，但注意不可过多地使用注释。

(5)注释是对代码的"提示"，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。

(6)如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。例如

i++;  // i 加 1，多余的注释

(7)边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

(8)注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。

(9)尽量避免在注释中使用缩写，特别是不常用缩写。

(10)注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。

(11)当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l5cDAzMDREZXZpbg_size_16_color_FFFFFF_t_70][]

## ④命名规则 ##

所有标识符的命名必须遵循如下三种大小写规范进行命名：

<table style="margin-left:.3333in;"> 
 <tbody> 
 <tr> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.152in;"> 风格 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:3.5826in;"> 说明 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.1944in;"> 样例 </td> 
 </tr> 
 <tr> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.1715in;"> Pascal&nbsp;大小写 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:3.5826in;"> 首字母大写，且后续单词的首字母都必须大写; &nbsp; 本规则一般用于&nbsp;三个或更多字母的标识&nbsp;的情况 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.2222in;"> &nbsp;BackColor </td> 
 </tr> 
 <tr> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.1715in;"> Camel&nbsp;大小写 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:3.602in;"> 首字母小写，且后续单词的首字母都必须大写； &nbsp; 本规则仅用于&nbsp;函数参数和保护实例成员的命名&nbsp;中 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.2222in;"> &nbsp;backColor </td> 
 </tr> 
 <tr> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.152in;"> 大写格 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:3.5826in;"> 所有字母都必须大写 &nbsp; 本规则仅用于&nbsp;标识只有两个或更少字母&nbsp;的情况 </td> 
 <td style="border-color:#a3a3a3;vertical-align:top;width:1.3263in;"> &nbsp;System.IO &nbsp;System.Web.UI </td> 
 </tr> 
 </tbody> 
</table>

## ⑤变量，常量与类型 ##

### 变量 ###

### **变量的作用域** ###

*  类的字段所处的作用域等同于该字段所属类所在的作用域
 *  局部变量的作用域仅限于声明它的方法或循环体内部，以大括号｛｝为界

变量其实是一个点位符，它引用了一块内存地址，但它存储的值是可以变化的。

### 常量 ###

*  在声明时立即初始化，其值在初始化后将无法再进行更改
 *  使用显式类型声明，不能使用关键字var
 *  可以在类、结构、接口中进行声明
 *  可以作为类、结构、接口的字段，也可以是定义在类、结构中的方法内部的局部变量，事实上常量永远是静态的，虽然并没有使用static关键字(也不允许)
 *  无法接受变量的赋值，哪怕该变量是static并且是readonly也不行，在初始化时只能使用另一个常量为它赋值，当然直接赋予一个具体的值更好

### 类型 ###

值类型和引用类型

## ⑥表达式与语句 ##

用括号确定表达式的操作顺序，避免使用默认的优先级。

为了防止产生歧义并提高可读性，应当用括号确定表达式的操作顺

## 还有很多，其余待续... ##

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l5cDAzMDREZXZpbg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200105205236773.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l5cDAzMDREZXZpbg==,size_16,color_FFFFFF,t_70