你遇到过的源代码中最好的注释是什么?
当前回答
这个我在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))
其他回答
// TODO: not this
上面写了一个同事迫切需要优化的查询。替他说句话,当时我们几个月都是每周工作70个小时……
//The following code is commented out
//(a load of commented out code followed)
// this error could never happen
然后,客户打电话说他看到一条错误消息说"这个错误永远不会发生"
// Catching exceptions is for communists
来自Mike Duncan在SQLite上的页面。
//Please comment on your source code
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?