你遇到过的源代码中最好的注释是什么?
当前回答
我继承了一个没有任何UAT交付给客户的项目。它被踢出了栅栏,要求赔偿。
他们第一次使用它,它自然就爆炸了。它是一个插入库,可以覆盖任何以文件名而不是文件描述符作为参数的系统调用。
许多系统调用已经被遗忘。
当我开始使用这款游戏时,它的代码包含了以下内容:
/* core dumps around here but this is hardly ever called */
and
/* don't know why this works but it seeems to be ok */
哦,没有单元测试。一位同事已经开始添加缺失的系统调用和单元测试。
编写代码的那些混蛋还在团队中,他们根本不在乎已经交付的垃圾!
其他回答
// BEGIN HACK
...
// END HACK: I feel dirty.
//没有评论
我经常发现这个
// fix it!
我在一个充满显式怪异类型转换的函数中见过这段代码:
// Since today's CPUs are really fast, this is dedicated to those who said:
// " You can't use Moore's Law as an excuse to write bad software. "
代码太可怕了:)
// need a coffee to fix this.
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?