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

Posted 2022-06-12 hmswt

为什么要写注释？

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

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

注释的原理

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

如何写注释

单行注释

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

多行注释

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

文档注释

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

代码规范

经过这几天的学习，你们应该能发现我的代码都是有缩进的，如果不缩进行不行？从技术上说，行。

你们也能看到我都是一行只写一条语句，那我写多条行不行？从技术上说，也没问题。

可是你想过吗？将来我们要写的代码是很多的，所以一定要规范，这样将来读起来才更容易，维护起来也更简单。所以一定要有缩进，要层次分明，一行只写一条语句，上下的大括号要对齐，变量名字要见名知意…… 

养成好习惯，从现在做起。

快捷键

1. 快速排版代码 ctrl+K接着ctrl+D。对齐啊缩进啊什么的都要规范的，vs提供了一个功能就是快速排版，如果代码乱了按一下快捷键，就有条理多了。
2. 注释所选代码 ctrl+K接着ctrl+C。先选中需要注释的代码，一行或者多行，然后使用这个快捷键。相当于在选中的每行代码前自动添加//。
3. 取消注释代码 ctrl+K接着ctrl+U。如果有批量被注释的代码，用此快捷键相当于去掉选中的每行代码前的//。