你遇到过的源代码中最好的注释是什么?
当前回答
/* Please work */
其他回答
// This interface defines method signatures<br>
interface IWhatever { ... }
最近在我们的代码中发现了这一点(我们开发企业软件):
// Instance of excel
Excel excel = this.CreateExcelInstance();
excel.Open(stream); // how to close it?!
在此之前,我确信我们已经摆脱了这些“有趣的东西”,我们正在以正确的、意识形态正确的方式做这件事……
这是我们在前雇主购买的智能卡产品中发现的唯一一条评论。一群荷兰密码学博士写的嵌入式C语言和汇编程序
// echt halmaal gek - no way!
(它的意思是“真的完全愚蠢”……这对我们也没有帮助)
我猜它被病毒式传播了,我在一个守护进程(Linux)中发现了以下防止OOM杀手选择它:
/*
* Don't OOM me, bro!
*/
这紧跟在mlockall()之后,以防止进程交换,注释如下:
/*
* Don't swap me, bro!
*/
在几年前编写Perl时,我在顶部和底部添加了这些注释:
# <magic type="voodoo">
...
# </magic>
下一个研究它的人在Perl中并不是那么热门,他花了一段时间搜索文档,看看“魔法”和“巫毒”是怎么做的。从那以后,我试着添加更多有用的评论……
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?