你遇到过的源代码中最好的注释是什么?
当前回答
有一些旧的javascript代码,写得很好。然后是一条评论线
// and there is where the dragon lives
接下来是一个功能,4个人花了一天时间来理解它在做什么。最后我们意识到它根本没用,什么都没有。
其他回答
从技术上讲,这不是一个评论,而是在凌晨2点左右编写的代码:
consent = False
... 该变量永远不会再次使用,并且出现在套接字的监听循环的开始。
经典ASP:
'Is it worth it, let me work it'
'I put my thing down, flip it and reverse it'
'Ti esrever dna ti pilf, nwod gniht ym tup I'
NextIP = StrReverse(UserRecordset.Fields.Item(0))
在几年前编写Perl时,我在顶部和底部添加了这些注释:
# <magic type="voodoo">
...
# </magic>
下一个研究它的人在Perl中并不是那么热门,他花了一段时间搜索文档,看看“魔法”和“巫毒”是怎么做的。从那以后,我试着添加更多有用的评论……
注意上面代码中的bug;我只是证明了它是正确的,并没有尝试过。
这是唐纳德·克努斯写的。
// Hard to explain
它最后也坏了。难怪很难解释清楚
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?