你遇到过的源代码中最好的注释是什么?
当前回答
有一次,我在另一个讨论中看到这样的内容:
// I can't divide with zero, so I have to divide with something very similar
result = number / 0.00000000000001;
聪明的解决方案,不是吗?(如果有人不确定,这就是个笑话)
其他回答
在一组相当长且复杂的while循环和if块的末尾,开发人员插入了最后的注释:
else
{
// wobbly wilson said this would *never* happen!!
}
机智和讽刺的简洁混合:)
// Sorry dirty code
一个奇怪而恰当的有趣错别字:
断言(0);//永远不要在这一点上犯错
{
This is a gathering place for all unit tests.
Create a TUnitTestWrapper, then call "RunAllUnitTests".
This class will create an instance of each thing to be tested, and call each of
their unit tests.
It does not really do any testing on it's own; it just gives a common place from
which to call everyone else's tests.
This way, one day, we can automate our testing with each build. [Cue laughter]
}
我看到有人对代码的评论:
// This comment is self explanatory.
我猜他是想说“可变的”,但这个错误造成了一个有趣的评论……想想这里的循环逻辑,以及写它的徒劳。
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?