你遇到过的源代码中最好的注释是什么?
当前回答
我不止一次使用过这个方法,当我对一个数学公式做了一些不明显的简化时,我不想记录:
//this formula is right, work out the math yourself if you don't believe me
其他回答
我最喜欢的是这样的
# commented out ... ### end of the formerly uncommented #2001-02-22 John Doe
const int TEN=10; // As if the value of 10 will fluctuate...
不是代码注释,而是SVN在同一个文件上提交注释:
第一次提交(在测试人员返回结果后,再进行数十次提交):
Squashed some IPR mod bugs. The were big and juicy ones, too.
2日提交:
Squashed some more mod bugs. Those are some nasty bugs, them mod bugs...
3rd:
Squashed some more mod bugs. They are like cockroaches: they'll live through a nuclear war.
4th:
Squashed some more John bugs. They too are like cockroaches: they appear anywhere John goes. Wait. That doesn't sound right.
5:
Same John bug. It didn't die, just played 'possum.
是的,我厌倦了"修复bug"
事实上,有一天我在一些代码上看到了这个,这些代码是在截止日期很急的时候写的。
//This was clearly written under duress
# let's pretend we are free, for a while
在教室前面发现了这个。接下来是一个(天真的)实现ORM的尝试。我还是不明白他为什么这么写。
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?