你遇到过的源代码中最好的注释是什么?
当前回答
有一次,我在另一个讨论中看到这样的内容:
// I can't divide with zero, so I have to divide with something very similar
result = number / 0.00000000000001;
聪明的解决方案,不是吗?(如果有人不确定,这就是个笑话)
其他回答
大约10年前,我从事图像处理工作,通过扫描显微镜视频帧来检测细胞运动。我当时在做一个特别复杂的工作,决定和朋友出去喝一杯。当我回到家时,我工作了一会儿,但没有太多,因为我喝醉了。第二天早上,我发现了一个10行完全混乱的函数,带有以下注释(显然是我自己写的):
/* Ah ah ah! You'll never understand why this one works. */
最奇怪的是,它竟然起作用了。
在XSLT文件的头文件中:
DON'T TOUCH THIS SCRIPT -> XSLT is like arcane, black magic
以下注释来自我必须调试的一个旧项目:
//Haleluya i can go home!
这是我最喜欢的评论。
/// I intend to do this as shittily as possible because there are many better products that will totally blow this out of the water
/// and we don't have them so whatever
在后面的文件中,我们有更多的乐趣
/// sidestep a bug in WCF (that we can't send types across)
/// or, depending on how you look at, this issue is a Feature
稍后再讲
if( where == null)//be nice
大概30页的xslt的中间部分
<!-- Here be dragons -->
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?