【小雨学编程之C＃】程序说明

当我们的代码行数变多，一段时间后，我们会忘记之前编辑代码的意思，需要重新读我们之前编写的代码，这样加重了开发的负担。这时候我们就需要一个我们编写代码的说明，从而通过说明很快的想起之前编写代码的思路，同时看别人的代码说明，也能很快上手学习和修改别人的代码。

这时候，我们就需要代码注释（标注和解释，简称注释）

注释就是对代码的解释和说明。目的是为了让别人和自己很容易看懂，一看就知道这段代码是做什么用的，提高程序代码的可读性。

注释只是为了提高可读性，不会被计算机编译。

一、C#的注释有三种，单行注释、多行注释、文档注释

单行注释：适用注释一行内容（简短的一行解释）

语法：//注释内容

多行注释：适用注释跨行内容（比较多的跨行解释）

语法：/*注释内容*/

/*多行注释开始标识符

*/多行数值结束标识符

文档注释：给代码段添加注释（解释一段整体内容）

语法：///

///

///

注：只需要在对应位置敲入///Visual Studio会将其余内容自动生成

文档注释可以用在命名空间、类、函数上，但是我们发现当使用在命名空间、类上的时候仅仅是

但是使用在入口函数上的时候却变成

这是怎么回事？

其实对于文档注释，我们经常用到的是三种标识summary、param、returns

summary：摘要信息

param：参数说明

returns：返回值说明

简单举例

二、注释快捷按钮和快捷键

快捷按钮

ctrl+k+c：注释所选代码

ctrl+k+u：取消对所选代码的注释

三、注释常见错误

嵌套多行注释错误

多行注释使用过程中，一个/*只能直接对应一个*/，否则嵌套过程中/*会直接匹配所在范围的第一个*/而将其余的注释忽略

单行注释嵌多行注释错误

单行注释会将这一行的所有内容都认成注释，此时的/*会被识别成单行注释的一部分，而并没有识别成多行注释的开始标识符

四、注释两大作用

代码解释和代码调试

代码解释就是在对应代码位置，起到代码意思标识的作用

代码调试：

当我们要调试代码，希望看到不同的运行效果，但是又不想删除对应的代码的时候，可以将差异化的代码进行注释，调试过程中，可以用注释和取消注释的方式，运行代码以看效果。