你遇到过的源代码中最好的注释是什么?
当前回答
// TODO: Finish.
其他回答
// Holy moses! I've never seen anything so ridiculous in all my life.
// Why do we need to query the AlarmIDs table twice.
// Please tell me sir; I would really like to know.
// This like all the other services have been mangled
// to the point where they are nearly impossible to determine what kind of side affects might occur.
// I am making the smallest changes I can to this code.
// The GetAlarmId method gets the alarm id from the AlarmIDs table.
// Novel idea, why didn't we query for the values be get below all in the same place.
// This should be changed, but right now it will have to remain as is due to time constraints.
// This like all other services really don't do anything fantastically hard, but after the original coders got
// done with them; they are difficult to work with and have an acceptable comfort level.
//把这个放在这里的人是个白痴…这根本不管用!
但是代码还在那里……
在1983年的COBOL中见过:
C I don't know what this next bit does so I'll jump around it
GOTO DONE.
唐纳德·克努斯的另一个经典作品:
注意上面代码中的bug; 我只是证明了它是正确的,并没有尝试过。
几年前,我在一个没有单元测试可言的大型代码库中工作。
代码中隐藏了一个执行一些日历计算的方法。它有点坏了,由于一些不幸的情况,不得不以一种非常笨拙的方式处理夏令时。
我们不得不修了几次,每一次,我们都会在几个月后发现一些东西坏了。
在花了一整天的时间修复和分析之后,我把代码放到了源代码控制中,并附上了这样的评论:
// this code was written after a version trying to do {this} failed because of {reason},
// previously we were doing {this} which failed because of {reason}. This is
// now written {this} way so that {lots of reasons here}. If you want to touch
// this code, please make sure that it produces the right answers when tested with:
//
// {some sort of unit test}
最终,我的团队被外包了。有时我想知道这段代码发生了什么:)
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?