你遇到过的源代码中最好的注释是什么?
当前回答
这是我们团队微观管理效果的一个活生生的例子:
// I am not responsible of this code.
// They made me write it, against my will.
... 我们敬爱的技术总监很喜欢把代码和编码指南都硬塞到开发人员的喉咙里(*)。
当然,当项目负责人寻找bug的原因时,发现它在“非最佳代码”中,他就不那么高兴了……
(*)当然,我指的是强大的VB国王……如果你想评估强大的VB国王的全部力量,你可以阅读下面的SO帖子:你被迫遵循的最奇怪的编码标准规则是什么?...
其他回答
我在遗留代码中注意到的修改日志
05/17/99 d琼斯评论出来 血腥的auzies代码(02/19/99) k罗宾逊该死的德克萨斯人 不能正确拼写aussie(没有代码 改变-只是一个评论)
-- Change Log: Not needed. The code is perfect 'cause I wrote it.
-- If you change it, it will break.
我正在检查一些代码注释,以检查它们是否有意义,并看到上面的一行。
我曾经使用MS SQL Server Developer 2000实现了一些文档工作流(人工工作流的东西)。
它由一堆触发器组成,这些触发器将被添加到数据库中,使其遵循工作流规则。
在其中一个触发器中,微软的某个人写了如下内容:
//Determine if the database has been "Grizzlified"
(该产品的内部名称是“Grizzly”,所以我觉得这很有趣)。
// TODO: Implement this function!
这个我在Python 2.5的“twisted”包中找到的(文件是tcp.py在第371行)
# Limit length of buffer to try to send, because some OSes are too
# stupid to do so themselves (ahem windows)
return self.socket.send(buffer(data, 0, self.SEND_LIMIT))
推荐文章
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?
- 你遇到过的源代码中最好的注释是什么?
- 在Bash中创建多行注释的方法?