你遇到过的源代码中最好的注释是什么?
当前回答
前段时间我看到:
raise InvalidChild() # e.g. no legs
这很奇怪,因为“inwalida”在波兰语中是残疾人的意思。愚蠢的我:)
其他回答
我看到有人对代码的评论:
// This comment is self explanatory.
我猜他是想说“可变的”,但这个错误造成了一个有趣的评论……想想这里的循环逻辑,以及写它的徒劳。
// Jay knows what's going on here, but will he remember in a year? Not very likely, this code sucks, but it works so do not change it.
这条评论被贴在一个巨大的“如果”区块上…哦,它操纵一个对象数组的对象数组的对象数组的字符串对象数组,可以是字符串或数字,取决于至少3个因素…(是的,我必须调试这段代码并更改它,我写了注释,但我没有写原始代码)。;)
经典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))
//Dear future me. Please forgive me.
//I can't even begin to express how sorry I am.
我今天刚发现了这个:
//private instance variable for storing age
public static int age;
我的一个老老板总是说我们必须在内部使用我们自己的产品。“吃我们自己的狗粮……”
许多年后,我发现嵌入在一个临时同事所做的源代码中,他触及的每个函数都被标记为:
/* NOT FIT FOR HUMAN CONSUMPTION */
推荐文章
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?
- 你遇到过的源代码中最好的注释是什么?
- 在Bash中创建多行注释的方法?