为什么要写注释?

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

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

注释的原理

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

如何写注释

单行注释

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

多行注释

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

文档注释

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

代码规范

经过这几天的学习,你们应该能发现我的代码都是有缩进的,如果不缩进行不行?从技术上说,行。
你们也能看到我都是一行只写一条语句,那我写多条行不行?从技术上说,也没问题。
可是你想过吗?将来我们要写的代码是很多的,所以一定要规范,这样将来读起来才更容易,维护起来也更简单。所以一定要有缩进,要层次分明,一行只写一条语句,上下的大括号要对齐,变量名字要见名知意…… 
养成好习惯,从现在做起。

快捷键

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

c#小灶——注释和代码规范的更多相关文章

  1. python基础1 - 多文件项目和代码规范

    1. 多文件项目演练 开发 项目 就是开发一个 专门解决一个复杂业务功能的软件 通常每 一个项目 就具有一个 独立专属的目录,用于保存 所有和项目相关的文件 –  一个项目通常会包含 很多源文件 在 ...

  2. Python10_代码规范和可读性

    养成好的编程习惯和方法对提升代码可读性至关重要. 1.类.模块.包:不要用下划线,命名要简短 2.类:命名最好以大写开头 3.模块.包:用小写单词 4.变量.函数.方法:可以用下划线提高可读性,尽量都 ...

  3. 《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:文件注释、文档注释、代码注释、使用地标注释

    原创文章,欢迎转载.转载请注明:关东升的博客 前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/).这里来介绍一下他们的使用规范. 1.文件注释 文件注释就在每一个文件开头 ...

  4. 菜鸟笔记 -- Chapter 4.7 代码注释与编码规范

    4.7 代码注释与编码规范 在程序代码中适当的添加注释可以提高程序的可读性和可维护性.好的编码规范可以使程序更易阅读和理解.下面我们将介绍几种代码注释,以及应该注意的编码规范. 4.7.1 代码注释 ...

  5. python基础(代码规范、命名规范、代码缩进、注释)

    代码规范 PEP8(python增强建议书第8版) 每个import语句只导入一个模块 不要在行尾添加分号";" 建议每行不超过80个字符   超出部分可以用()来进行换行例如: ...

  6. python代码规范以及函数注释规范

    摘要 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见​PEP7.本文和​PEP 257 文档字符串标准改编自Guido最初的<Python Style Guide&g ...

  7. iOS代码规范(OC和Swift)

    下面说下iOS的代码规范问题,如果大家觉得还不错,可以直接用到项目中,有不同意见 可以在下面讨论下. 相信很多人工作中最烦的就是代码不规范,命名不规范,曾经见过一个VC里有3个按钮被命名为button ...

  8. iOS 代码规范

    1 目的 统一规范XCode编辑环境下Objective-C.swift的编码风格和标准 2 适用范围 适用于所有用Objective-C,swift语言开发的项目. 3 编码规范 3.1 文件 项目 ...

  9. php代码规范—2

    如何写出好的 PHP 代码? 在本文中,我们将探讨一些良好的编程习惯,这将帮助你避免代码中的缺陷. 1- 编写模块化代码 良好的PHP代码应该是模块化代码.PHP的面向对象的编程功能是一些特别强大的工 ...

随机推荐

  1. Java8新特性——lambda表达式.(案例:公司业务)

    需求:现有一个员工姓名list,其中包含单字母索引.要求输出一个字符串,去掉所有单字母,所有名字首字母大写并用逗号隔开. package cn._2.thecompanyprocess; import ...

  2. CLR 垃圾回收算法

    c#相较于c,c++而言,在内存管理上为程序员提供了极大的方便,解放了程序员与内存地址打交道,提高了程序员的工作效率.比如c中分配的malloc堆空间没有释放导致的内存泄露,数组越界导致的踩内存错误, ...

  3. OSI参考模型---网络基础篇(1)

    什么是网络 网络就是将分布在不同地理位置,具有独立功能的终端(一切联网的设备都叫终端:例如电脑,手机,智能家电等等联网的设备),通过通信线路(双绞线.光纤.电话线等等)和通信设备(例如:交换机.路由器 ...

  4. C# 死锁 TaskCompletionSource

    在异步转同步时,使用不当容易造成死锁(程序卡死) 看如下案例: 有一个异步方法 private static async Task TestAsync() { Debug.WriteLine(&quo ...

  5. decimal.ToString()问题

    decimal dt = 1.00M;            decimal dt1 = 1M;                         bool d = dt == dt1;         ...

  6. JS高级程序设计第2章--精简版

    前言:这次是二刷了,想暑假做一次完整的笔记,但用本子来写笔记的话太贵了,可能哪天还丢了..所以还是博客好== 第二章:在HTML中使用JavaScript 2.1 <script>元素: ...

  7. HDU 1286:找新朋友(欧拉函数)

    http://acm.hdu.edu.cn/showproblem.php?pid=1286 题意:中文. 思路:求欧拉函数. #include <cstdio> #include < ...

  8. oraclesql遇见的问题(一)

    在oracle的数据库,对于字段为null的字段过滤条件只能用is null 或者 is not null,不能使用 != , <> , = 判断, 今天进行接口测试时,发现获取到的数据缺 ...

  9. pod lib create ObjcName 时候报错error: RPC failed; curl 56 LibreSSL SSL_read: SSL_ERROR_SYSCALL, errno 54

    众所周知 pod lib create ObjcName 需要从git 上边克隆模版 :https://github.com/CocoaPods/pod-template.git 然后有时候会很慢报错 ...

  10. scrapy实战6爬取IT桔子国内所有融资公司:

    爬取融资公司,融资公司简介,融资时间,轮次,融资额,投资方,股权占比以及融资公司完整融资历史 如图 源码地址:https://github.com/huwei86/spiderITjuzi