C#注释的应用

注释是为了让别人能更快的看懂你的代码的最快路径。

一、注释约定

1.类注释

/// <summary>

/// 用户信息

/// </summary>

public class UserInfor

2.类属性注释

 /// <summary>

/// 用户ID

/// </summary>

public int UserID { get; set; }

3.方法注释

/// <summary>

/// 用户登录

/// </summary>

/// <param name="userName">用户名</param>

/// <param name="password">密码</param>

/// <returns>返回数据结果</returns>

public ActionResult UserRegister(string userName, string password)

4.代码间注释

①单行注释：注释行数<3行时使用

//单行注释

②多行注释：2<注释行数<=10行时使用

/*多行注释1

多行注释2

多行注释3*/

③注释块：10<注释行数时使用， 用n个*

 

 

/**************************

*代码块注释1

*代码块注释2

*......

*代码块注释11

*代码块注释12

********************************/

5.对意料之中的疑问添加注释

当别人读你的代码的时候，有些部分可能让他们有这样的疑问：“为什么要这样写”你的工作就要给这些部分添加注释

 //定义删除图片方法

public void DeleteFile(string strPictureName)

   {

        string strPath = AppDomain.CurrentDomain.BaseDirectory + "image\\";

        //第一步：判断文件是否存在

        if (!Directory.Exists(strPath))

         {

              //路径不存在：创建文件路径

             Directory.CreateDirectory(strPath);

          }

         if(strPictureName!=string.Empty || strPictureName != null)

          {

               //获取原来的图片

               string strOldUrl = strPath + strPictureName;

               //删除文件

               File.Delete(strOldUrl);

           }

       }

二、命名规范

1. 我们在命名标识符时（包括参数，常量，变量），应使用单词的首字母大小写来区分一个标识符中的多个单词，如UserName.
2. PascalCasing

PascalCasing包含一到多个单词，每一个单词第一个字母大写，其余字母均小写，例如：HelloWorld、UserName等。除了参数、变量、常量外，所有的命名空间名称、类、函数、接口、属性、事件、枚举等名称的 命名，使用Pascal风格。

3.camelCasing

camelCasing包含一到多个单词，第一个单词首字母小写，其余单词首字母大写。例如：userID、studentName等，。参数与变量的命名使用camelCasing

4.私有变量的命名

Private 的私有变量使用下划线"_"+camelCasing的大小写规则，以便快速确认该变量的作用域。