你遇到过的源代码中最好的注释是什么?
当前回答
刚从大学毕业的我渴望亲自动手。我的第一个任务是……“为我注释此代码”。
傻瓜。
过了一段时间我就厌倦了……
// this function doesn't actually calculated the profit, like it says --it really signals the mothership orbiting saturn that the planet is ripe for takeover
[later]
// I don't think anyone is going to read this
[various permutations on that last one]
其他回答
我曾经在一个用Paradox 3.5 -编写的大型预算系统工作多年后接到一个客户的电话
“我们在调试中遇到了一些注释”-
// This shouldn't happen, if it does, then the bits that automagically
// worked when I wrote it have stopped working
... !
// Oh crap, i think i'm gonna yack
随后不久又有:
// TODO: end this lunacy
来自一个显然在看巨蟒剧团的小伙子:
> //现在,for something完全 > // different: 类theLarch {
今天刚加了这个:
// Hardcoded this for time sake ... will make andrew fix later :)
我没有亲身经历过这种情况,但这是一个很好的故事(详见我的评论中的解释):
#define MSGTAG_B33R 0x723 /* RIPLVB */
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?