c#小灶——注释和代码规范

为什么要写注释？

早上我写完了代码，我和我的朋友们都能看懂，到了晚上，我还能看懂，一周后，就只有上帝能看懂了……

1. 将来我们写的代码量是很大的，代码又不像我们自然语言这么好理解，可能过段时间我们就不认识自己的代码了，所以我们要养成写注释的好习惯。
2. 团队合作当中，写了注释更容易使别人读懂你的代码。
3. 注释的作用除了解释说明，还有一个比较常用，因为注释不被编译的特性，我们经常会把一些暂时用不到的代码注释掉，这样的话如果突然需要就可以拿来用了。如果删掉了，再用就只能重新写了。

注释的原理

我们在代码当中写注释，只会方便我们理解，真正编译的时候，编译器会跳过注释的部分，所以写注释不会对我们的程序产生任何影响。它只是给人看的，机器不看。

如何写注释

单行注释

单行注释的写法是//，//后面的内容都不会被编译

多行注释

多行注释的写法是以/*开头，以*/结尾，它们中间的内容不会被编译。

文档注释

文档注释这个比较特殊，因为它的目的是生成一份程序的说明文档，所以它会被编译，但是不会被执行。单行注释和多行注释可以写在任何地方，文档注释只能写在类和方法的前面。