你遇到过的源代码中最好的注释是什么?
当前回答
顶部的:靠近单位顶部的:
// Oh what a tangled web we weave
// When first we practice to deceive
// ASTA
其他回答
'this next if statement - just how it is. don't try to understand it because you won't. :)
这就是工作保障。
// human madable inconvenient. Way too sucks.
我仍然没有完全理解它的含义,但我发现它对于许多代码来说是非常正确的。
我一直很喜欢Paul DiLascia在他的文件头中写的:
// If this code works, it was written by Paul DiLascia. If not, I don't know
// who wrote it
我参与的一个大型项目在自动构建中使用了StyleCop和FXCop,并使用规则来防止人们检入带有未注释字段、方法、属性等的代码。
有些人对必须添加“获取或设置全名”之类的注释到自记录属性(如FullName)感到非常恼火,以至于他们不得不努力编写一个宏来绕过这些规则。
宏为方法、属性等插入了XML摘要标记,其中一个单一的不显示Unicode字符作为标记内容,这将欺骗构建规则,同时对为了注释而盲目坚持的东西进行轻微打击……
...至少直到他们引入了另一条规则来检查注释中的Unicode字符。
// this is really complicated
没有其他评论了
推荐文章
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?
- 你遇到过的源代码中最好的注释是什么?