你遇到过的源代码中最好的注释是什么?
当前回答
对上帝诚实:
// This is crap code but it's 3 a.m. and I need to get this working.
其他回答
// Added because boss changed his mind : 20020111,20020501,20020820, ...
// Commented out because boss changed his mind : 20020201,20020614,20020908, ...
在ETL脚本之间的主要黑客RPG数据库和SQL Server一个。我大概有10到20次这样的评论……
我经常看到这种情况:
// TODO make this work
.class {border:1px solid gold;} /*我可怜这个傻瓜*/
我猜它被病毒式传播了,我在一个守护进程(Linux)中发现了以下防止OOM杀手选择它:
/*
* Don't OOM me, bro!
*/
这紧跟在mlockall()之后,以防止进程交换,注释如下:
/*
* Don't swap me, bro!
*/
我参与的一个大型项目在自动构建中使用了StyleCop和FXCop,并使用规则来防止人们检入带有未注释字段、方法、属性等的代码。
有些人对必须添加“获取或设置全名”之类的注释到自记录属性(如FullName)感到非常恼火,以至于他们不得不努力编写一个宏来绕过这些规则。
宏为方法、属性等插入了XML摘要标记,其中一个单一的不显示Unicode字符作为标记内容,这将欺骗构建规则,同时对为了注释而盲目坚持的东西进行轻微打击……
...至少直到他们引入了另一条规则来检查注释中的Unicode字符。
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?