C#注释写法

C#中常见的几种注释写法:


 

1.  //annotate    :双斜杠注释,用于单行注释

 

//这是一个注释

 

2.  /*annotate*/   :用于多行注释,可换行

/*
这是一个注释
可以多行切换
*/

 

3.  ///             :三斜杠注释,多用于注释代码块具体含义

/// <summary>
/// 代码块注释
/// </summary>
/// <param name="参数名">参数注释</param>
/// <returns>返回值注释</returns>

举一个简单例子如下:(本例使用VS2022IDE)

/// <summary>
/// 计算两数之和 
/// </summary> /// <param name="x">第一个加数</param>
/// <param name="y">第二个加数</param> /// <returns>两个加数的和</returns> public double GetSum(int x,int y) { double sum = x + y; return sum;
}

将光标悬停在方法上

将光标悬停在参数上

 

尤其适用于写库文件的时候或者写给别人去调用的接口的时候


 4.  #region annotate ......  #endregion    :折叠注释

直接举例如下:

 折叠效果如下:

 当存在很多功能实现上并列的方法时使用#region注释会看起来更简洁.

 

留下一个坑:引自https://www.cnblogs.com/endv/p/6369005.html

 

posted @ 2023-01-09 20:51  丛雨灬  阅读(97)  评论(0)    收藏  举报