C# （初入江湖） -注释&命名规则

注释

注释用来对编写的代码进行说明，包括功能说明以及实现说明，这样可以大大的提高程序的可读性，另外规范的注释还可以通过工具来生成相应的API文档

注释的作用

• 说明当前代码的作用以及意义
• 暂时去掉不用代码，让其不参与编译运行

注释的种类

• 代码单行注释：使用 // 代表其后内容是注释部分

// int a=1  注释掉这个代码

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

/* 
  这是多行1
  这是多行2
  这是多行3
  */

• 文档注释：文档注释一般多用于类、类属性和方法的前面，说明该类和方法的作用以及意义， 在方法或者类的前一行打出 ///，VS自动添加文档注释

public class Person
{
    /// <summary>
    /// 定义 name 属性
    /// </summary>
    public string name;

    /// <summary>
    /// 无参构造
    /// </summary>
    public Person(){
        this.sayHello();
    }

    /// <summary>
    /// 定义方法 打印hello
    /// </summary>
    public void sayHello()
    {
        Console.WriteLine("hello");
    }
}

注： 单行注释 // 和多行注释 /* */ 不会被编译；但是 文档注释 /// 会被编译（但不影响执行速度），文档注释会在其他的人调用你的代码时给出智能提示，同时后期也可用来生成相应的API文档

命名规范

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

常用的两种命名方法

• Pascal （帕斯卡）命名法：每个单词的首字母大写
  • 如：StudentInfo、PersonTest、StringUtil、DateUtil
• Camel （驼峰）命名法：第一个单词小写，从第二个单词开始每个单词的首字母大写
  • 如：studentName、personName、totalCount、getNum

变量的命名规则

• 遵循 Camel 命名法
• 尽量使用能描述变量作用的英文单词
• 在简单的循环语句中计数器变量可使用 i, j, k, l, m, n

string studentName = "张三";
int[] numerArray = { 1,2,3,4,5};
for (int i = 0; i < numerArray.Length; i++)
{
    Console.WriteLine(numerArray[i]);   
}

常量的命名规则

• 为了与变量有所区分，通常将定义常量的单词的所有字母大写，单词间以下划线隔开

// 定义一个最大值和 最小值
public const int MAX_VALUE = 100;
public const int MIN_VALUE = 1;

类的命名规则

• 类的命名规则遵循 Pascal 命名法,即每个单词的首字母大写

public class PersonTest
{

}

接口的命名规则

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

interface ICompare
{
  int CountNum();
}

方法的命名规则

• 方法的命名遵循 Pascal 命名法 (注：因本人做JAVA开发比较多，所以案例中的方法多以 Camel 驼峰的形式命名，但c#推荐的是 Pascal 方式，如：值类型自带的 ToString() 方法等）
• 一般采用动词/宾语或宾语/动词顺序来命名，如：countNum 、buildStudent尽量做到见名知意

static void sayHello()
{
   Console.WriteLine("hello");
}

static int calNum()
{
    return 1 + 1;
}

更多好看的内容和好玩的案例请关注我的微信公众号： 程序猿知秋