你遇到过的源代码中最好的注释是什么?
当前回答
在一个艺术资产导出工具中,我偶然发现了一个从数字(阿拉伯)到罗马数字的完整转换器。它是这样的:
/*
//You can tell I was bored
//I wanted to do this for a long time
char* ConvertToRoman(int number, int base)
{
... whole code here
}
*/
编写这段代码的人的团队已经处理了很长时间,我猜这影响了他们的理智。
其他回答
我看到一些旧的fortran代码:
integer *4 one,two,three;
c asssign one to 100 before entering the loop
one=100;
Linux的评论
这里有很多不错的……
这些都是linux中的注释
http://lwn.net/1998/1015/a/f-word.html
我的最爱:
./arch/sparc/kernel/ptrace.c
/* Fuck me gently with a chainsaw... */
./drivers/scsi/qlogicpti.h
/* Am I fucking pedantic or what? */
不是注释,而是属性
[ThereBeDragons]
还有一个是我在IHttpHandler的实现中看到的
//What is this?
public bool IsReusable
{
get{return false;}
}
在JUnit API中找到:
/**
* ...as the moon sets over the early morning Merlin, Oregon
* mountains, our intrepid adventurers type...
*/
public Test createTest(Class theClass, String name) {
...
}
在几年前编写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需求文件添加注释吗?