C#中的注释和命名规范

1、注释

注释一般都以下两种作用：

说明当前代码的作用以及意义。

暂时去掉不用代码，让其不参与编译。

C#中包含三种注释：

1）单行注释

使用两个斜杠代表其后内容是注释部分。

举例如下：

 

2）多行注释

使用/* */ 代表多行注释，期间的所有内容都是注释部分。

举例如下：

 

3）文档注释

文档注释一般多用于类和方法的前面，说明该类和方法的作用以及意义。

举例如下：

在方法或者类的前一行打出三个斜杠，VS自动添加文档注释。

 

Tips：

平时写代码时也要有为代码添加注释的习惯。这样写出来的代码不仅美观，更容易维护。

2、命名规范

命名规则是为了让整个程序代码统一以增强其可读性而设置的。

常用的命名方法有两种：

Pascal 命名法（帕斯卡命名法）：每个单词的首字母大写

Camel 命名法（驼峰命名法）：第一个单词小写，从第二个单词开始每个单词的首字母大

写

1) 变量的命名规则

变量的命名规则遵循 Camel 命名法，并尽量使用能描述变量作用的英文单词。例如存放学

生姓名的变量可以定义成 name 或者 studentName 等。另外，变量名字也不建议过长，

最好是 1 个单词，最多不超过 3 个单词。

2) 常量的命名规则

为了与变量有所区分，通常将定义常量的单词的所有字母大写。例如定义求圆面积的 n 的

值，可以将其定义成一个常量以保证在整个程序中使用的值是统一的，直接定义成 PI 即

可。

3) 类的命名规则

类的命名规则遵循 Pascal 命名法，即每个单词的首字母大写。例如定义一个存放学生信息

的类，可以定义成 Student。

4) 接口的命名规则

接口的命名规则也遵循 Pascal 命名法，但通常都是以 I 开头，并将其后面的每个单词的首

字母大写。例如定义一个存放值比较操作的接口，可以将其命名为 ICompare。

5) 方法的命名规则

方法的命名遵循 Pascal 命名法，一般采用动词来命名。例如实现添加用户信息操作的方

法，可以将其命名为 AddUser