你遇到过的源代码中最好的注释是什么?
当前回答
几年前,我在一个没有单元测试可言的大型代码库中工作。
代码中隐藏了一个执行一些日历计算的方法。它有点坏了,由于一些不幸的情况,不得不以一种非常笨拙的方式处理夏令时。
我们不得不修了几次,每一次,我们都会在几个月后发现一些东西坏了。
在花了一整天的时间修复和分析之后,我把代码放到了源代码控制中,并附上了这样的评论:
// 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}
最终,我的团队被外包了。有时我想知道这段代码发生了什么:)
其他回答
// this is really complicated
没有其他评论了
在我们的应用程序中第一次重新编译FreeTextBox3,因为我们需要IE8支持…看看我发现了什么
// IE7 update. this is still bad code, but IE8 is probably a long way off :)
目前为止最好的一个:
"This code makes baby Jesus very sad!".
它像这样引用一个String的初始化:
String blankSpaces=" "+ //100 whitespaces
" "+ //200 Whitespaces
...
" " //100 whitespaces
你懂的。
以下是4个,排名不分先后:
// Father, forgive me, for I am sinning
// heaven help me
// horse string-length into correctitude
(from a textbook)
// what, me worry?
// This procedure is really good for your dorsolateral prefrontal cortex.
你们中有些人,由于某种特殊的原因,不知道DPC,当你深入学习新东西时,你大脑的这一部分会亮起来。
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?