你遇到过的源代码中最好的注释是什么?
当前回答
我个人最喜欢的是打油诗形式的文档:
Subclassing made Zope and TR
much harder to work with by far.
So before you inherit,
be sure to declare it
Adapter, not PyObject*
这可能会破坏这个笑话,但由于它有点晦涩,我将解释:
这里的TR指的是“扭曲的现实”。Zope 2和最初的扭曲。Reality包大量而不幸地使用了多重继承,这可能会使您在看到方法调用时难以理解发生了什么。Zope 3,扭曲自己,扭曲。现实的后继者(包括最近的假想)通常更倾向于组件组合。
其他回答
这是我们在前雇主购买的智能卡产品中发现的唯一一条评论。一群荷兰密码学博士写的嵌入式C语言和汇编程序
// echt halmaal gek - no way!
(它的意思是“真的完全愚蠢”……这对我们也没有帮助)
REM Don't delete this print statement ****** will die
所讨论的流程是一些遗留代码中的服务
我曾经使用MS SQL Server Developer 2000实现了一些文档工作流(人工工作流的东西)。
它由一堆触发器组成,这些触发器将被添加到数据库中,使其遵循工作流规则。
在其中一个触发器中,微软的某个人写了如下内容:
//Determine if the database has been "Grizzlified"
(该产品的内部名称是“Grizzly”,所以我觉得这很有趣)。
我猜它被病毒式传播了,我在一个守护进程(Linux)中发现了以下防止OOM杀手选择它:
/*
* Don't OOM me, bro!
*/
这紧跟在mlockall()之后,以防止进程交换,注释如下:
/*
* Don't swap me, bro!
*/
以下是4个,排名不分先后:
// Father, forgive me, for I am sinning
// heaven help me
// horse string-length into correctitude
(from a textbook)
// what, me worry?
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?