你遇到过的源代码中最好的注释是什么?
当前回答
在调试别人的JavaScript时,我看到了下面的评论:
// Notice: I feel so dirty doing this, but it's the only way to make it cross browser.
但在阅读Scott Hanselmen的一篇文章时,我看到了下面的引用,它与我在代码中发现的注释非常吻合:
Every line of code you write that you feel gross about will ultimately come back to haunt you. Therefore, avoid writing code that makes you feel dirty.
这很有趣。
其他回答
我曾经见过这个:
//this used to be a comment
我想我有过这样的经历:
if (case1) { // trivial
...
}
else { // we are screwed
/* fill in later */
}
好吧,我可能用了一个比搞砸更强烈的词
// GK Experimental
(GK是编码器的首字母缩写)
用来表示部分代码,实际上,是实验性的。:)
这是一个很好的标志,当你在调试过程中碰到它时,你可能会在接下来的几个小时里忙着修复黑客。;)
当我读到这篇关于我负责维护的项目的文章时,我哭了。
//Write Code Here
我仍然畏缩:)
// I dedicate all this code, all my work, to my wife, Darlene, who will
// have to support me and our three children and the dog once it gets
// released into the public.
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?