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

简介: c#小灶——注释和代码规范为什么要写注释?早上我写完了代码,我和我的朋友们都能看懂,到了晚上,我还能看懂,一周后,就只有上帝能看懂了……将来我们写的代码量是很大的,代码又不像我们自然语言这么好理解,可能过段时间我们就不认识自己的代码了,所以我们要养成写注释的好习惯。

c#小灶——注释和代码规范
为什么要写注释?
早上我写完了代码,我和我的朋友们都能看懂,到了晚上,我还能看懂,一周后,就只有上帝能看懂了……

将来我们写的代码量是很大的,代码又不像我们自然语言这么好理解,可能过段时间我们就不认识自己的代码了,所以我们要养成写注释的好习惯。
团队合作当中,写了注释更容易使别人读懂你的代码。
注释的作用除了解释说明,还有一个比较常用,因为注释不被编译的特性,我们经常会把一些暂时用不到的代码注释掉,这样的话如果突然需要就可以拿来用了。如果删掉了,再用就只能重新写了。
注释的原理
  我们在代码当中写注释,只会方便我们理解,真正编译的时候,编译器会跳过注释的部分,所以写注释不会对我们的程序产生任何影响。它只是给人看的,机器不看。

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

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

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

代码规范
经过这几天的学习,你们应该能发现我的代码都是有缩进的,如果不缩进行不行?从技术上说,行。
你们也能看到我都是一行只写一条语句,那我写多条行不行?从技术上说,也没问题。
可是你想过吗?将来我们要写的代码是很多的,所以一定要规范,这样将来读起来才更容易,维护起来也更简单。所以一定要有缩进,要层次分明,一行只写一条语句,上下的大括号要对齐,变量名字要见名知意……
养成好习惯,从现在做起。
快捷键
快速排版代码 ctrl+K接着ctrl+D。对齐啊缩进啊什么的都要规范的,vs提供了一个功能就是快速排版,如果代码乱了按一下快捷键,就有条理多了。
注释所选代码 ctrl+K接着ctrl+C。先选中需要注释的代码,一行或者多行,然后使用这个快捷键。相当于在选中的每行代码前自动添加//。
取消注释代码 ctrl+K接着ctrl+U。如果有批量被注释的代码,用此快捷键相当于去掉选中的每行代码前的//。
原文地址https://www.cnblogs.com/hmswt/p/11298986.html

相关文章
|
12月前
|
C#
C# .net webapi使用swagger时显示controller注释
C# .net webapi使用swagger时显示controller注释
202 0
|
4月前
|
存储 C# 开发者
C# 编程基础:注释、变量、常量、数据类型和自定义类型
C# 编程基础:注释、变量、常量、数据类型和自定义类型
|
5月前
|
XML 程序员 编译器
C#注释
C#注释
66 0
|
程序员 C#
C#基础①——注释、变量、快捷键、Write() 和WriteLine()、ReadKey()和ReadLine()的区别
C#基础①——注释、变量、快捷键、Write() 和WriteLine()、ReadKey()和ReadLine()的区别
C#基础Ⅱ-注释、快捷键、结构
C#基础Ⅱ-注释、快捷键、结构
|
5月前
|
Java 程序员 C#
C# 介绍、应用领域、入门、语法、输出和注释详解
C#(发音为“C-Sharp”)是一种由 Microsoft 创建的面向对象的编程语言,运行在 .NET Framework 上。源于 C 家族,与流行的语言如 C++ 和 Java 相近。首个版本发布于 2002 年,而最新版本,C# 12,于 2023 年 11 月发布
115 0
|
存储 程序员 C#
C#的注释、快捷键、字符和运算
C#的注释、快捷键、字符和运算
217 0
|
XML 开发框架 算法
【C#本质论 十一】合式类型(二)程序集引用、XML注释、垃圾回收和资源清理
【C#本质论 十一】合式类型(二)程序集引用、XML注释、垃圾回收和资源清理
136 0
C# .net webapi使用swagger时显示controller注释
C# .net webapi使用swagger时显示controller注释
387 0
|
XML C# 数据格式
C#封装程序集属性方法注释说明
一.使用封装程序集好处: 在很多分布式应用程序开发中,针对每一种功能可能条用的接口不一样,往往习惯将需要被调用的接口,封装成DLL给调用方应用后使用,这样既规范了调用的方式,又避免了调用出现参数请求方式的异常。
1127 0