注释应该用来描述代码

有相当多的原因,你可能想这样做:
1)你正在编写一个新的代码,还没有编译,你需要运行程序。如果有编译器错误,编译器不会让你运行。评论不会编译的代码将允许程序编译,所以你可以运行它。当你准备好的时候,你可以注释掉的代码,并继续它的工作。
2)你编写了一个编译,但不正确的代码,你没有时间来解决它,直到以后。评论被破坏的代码将确保破碎的代码不会执行,并导致问题,直到你可以解决它。
3)找到一个错误的来源。如果一个程序不产生预期的结果(或崩溃),它可以是有用的,在某些情况下,禁用您的代码的部分,看看你是否可以隔离什么导致它不正确的工作。如果你评论一个或多行代码,你的程序开始运行的预期(或停止崩溃),赔率是什么,你最后的评论是问题的一部分。然后,您可以调查为什么这些代码行导致这个问题。
4)你要用另一段代码替换一段代码。而不是只是删除原来的代码,你可以评论它,并离开它有参考,直到你确定你的新的代码工作。一旦你确定你的新代码正在工作,你可以删除旧的注释掉代码。如果你不能把你的新代码的工作,你可以随时删除新的代码和注释,旧代码回到你之前拥有的。
注释掉的代码做开发时常见的事,所以许多IDE提供了一个突出的评论部分代码支持。你如何使用这项功能不同的IDE(在Visual Studio中,你可以找到它在编辑菜单下的编辑->高级->评论选择/取消选择)。
这些教程中的注释

在整个本教程系列的其余部分,我将使用代码块内的注释来帮助说明事情如何工作。精明的读者会注意到,通过上述标准,这些评论大多是可怕的。当你阅读教程的其余部分时,请记住,评论是为一个故意的教育目的,而不是试图展示什么好的评论看起来像。

这些评论给用户一个想法的代码是如何去完成它的目标,而不需要太多的细节。
在语句级别上,注释应该用来描述代码为什么正在做某事。一个坏的语句注释解释了代码在做什么。如果你曾经写代码是如此复杂,需要一个评论来解释什么是一个声明,你可能需要重写你的声明,而不是评论。

我认为评论是一种“语言翻译”的方法。想象你正在尝试学习另一种语言,如法语。当你在学习法语的时候,你显然不会记得一眼后所学的一切,会有你会忘记的话,除非你的话,当然你去了他们许多许多倍。现在想象你只是一个部分的方式通过学习法语,但你去法国的一个假期,迫使你说法语在大多数地方你访问。理想的解决方案是带上一本法国英语词典,无论你走到哪里。你不会说法语,所以你必须使用法语-英语词典,以帮助你理解不同的句子在法语。这是用C++ -英语词典来帮助你记住在C++什么句子的意思。显然,这将是最终能够讲流利的C++很难,所以评论有点像C++的英文翻译。

一个坏的语句注释解释了代码正在做什么,你声称。
这是真的在许多情况下,但有时它可以是非常有帮助的解释什么代码正在做。
例如,当我学习PHP的我很难记住%的意义(模量)和增加每次使用模量一会儿直到我用心了解解释分工的解释剩余。
我认为最好的方法是简单地添加所有的意见,你觉得有帮助。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值