课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
代码注释是程序员在学习计算机编程开发语言的时候需要培养的一个编程习惯,下面我们就一起来了解一下,好的代码注释都有哪些作用。
1、恰当的注释
并不是所有的注释是不好的——有些注释实际上非常必要。
2、出于法律目的的注释
有时候,你可能需要出于法律目的编写特定的注释,比如开源项目的创作许可。一些现代化的IDE和文本编辑器会自动将它们折叠起来,保持工作区的整洁。
3、魔术表达式
如果你有一个复杂的SQL或正则表达式,它以神奇的方式做了一些令人兴奋的事,那么请务必注释,以便让读者更容易理解,因为我们不是Regex忍者。
4、说明意图
在某些情况下,注释有助于解释决策或特定解决方案背后的意图。例如,测试套件中的一条注释告诉我们添加这行代码是为了降低死锁的几率。
5、结果预警
用注释说明代码可能会产生严重的或可怕的后果,甚至鼓励这样做。在本例中,开发人员让读者知道,当与回调函数一起使用时,QT函数不是线程安全的。一般来说,如果一条注释可以避免某个人在编程时陷入绝望,那么它就是有用的。
6、TODO注释
这些注释可以帮助我们标记那些我们认为应该做,但是由于某些原因没有做到的事情。它可能会提醒你删除废弃的特性,或者请求其他人查看某个问题。它可能是要求其他人想一个更好的名字,或者是提醒他们根据计划事件做出修改。
【免责声明】本文系本网编辑部分转载,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。如涉及作品内容、版权和其它问题,请在30日内与管理员联系,我们会予以更改或删除相关文章,以保证您的权益!更多内容请在707945861群中学习了解。