你遇到过的源代码中最好的注释是什么?
当前回答
我所见过的最好的评论是
/*
There is no accounting for pointers
*/
其他回答
// WARNING!!!
// Very perversive code ahead!
... about a 20 lines of "very perversive" code ...
// Now you can call your grandmother back. ;)
// nobody read comments!
一些来自Linux内核的代码:
/* Sun, you just can't beat me, you just can't. Stop trying,
* give up. I'm serious, I am going to kick the living shit
* out of you, game over, lights out.
*/
-
/* 2,191 lines of complete and utter shit coming up... */
-
#if 0 /* XXX No fucking way dude... */
我没有亲身经历过这种情况,但这是一个很好的故事(详见我的评论中的解释):
#define MSGTAG_B33R 0x723 /* RIPLVB */
在一个名为“Bar”的类中(这是一个不具有描述性名称的UI控件),类头文件:
/// <summary>I pity the "foo".</summary>
Remove()方法:
/// <summary>A "foo" and his money are soon parted.</summary>
更糟糕的是,业务合作伙伴从生成的文档中指出了这一点。更糟糕的是,这些可能是我们从那家伙那里得到的最接近有用文件的东西。
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?