源代码中的热门注释

嗨哈布罗夫斯克 我在这里还没有写太多,但是设法尝试了几种格式的文章。这是我工作所在公司的一些IT专家的访谈,翻译,指南……有些东西进来了,有些没了。因此,今天我决定为自己尝试一种新格式。



在业余时间,我有时喜欢坐在Quora上-我回答其他参与者的问题,或者只是阅读有趣问题的答案。前几天,我遇到了一个相当受欢迎的问题。该线程有1000多个订阅者和100多个响应。问题是:您在源代码中看到的最佳注释什么?(原始。您遇到过的源代码中最好的注释是什么?)

我知道在stackoverflow和reddit上都有这样的线程,但是因为 我受到Quora答案的启发,因此决定从中进行选择。我浏览了大多数答案,并选择了最常出现的一对。

Costya Perepelitsa的回答


我见过的最好的评论,大概是Safety Pig(安全猪):



我从来没有完全确定它应该如何帮助我进行代码处理,但是无论如何,它都有效。

结果,我们将Safety Pig作为调试和安全增强过程的一部分:
“此代码的结构方式使检测内存泄漏特别困难。在每次提交之前,添加安全猪并通过Valgrind进行更改。”
“编译器无法在此处提供类型安全性,因此我们添加了Safety Pig以防万一。”
“我还没有单元测试,但我给它们加了一只猪。” (几乎工作)

对于那些想要拥有自己的安全猪的人,请忽略第一行。Quora代码块会自动删除第一行中的前导空格。

1. .
2.                         _
3. _._ _..._ .-',     _.._(`))
4.'-. `     '  /-._.-'    ',/
5.   )         \            '.
6.  / _    _    |             \
7. |  a    a    /              |
8. \   .-.                     ;  
9.  '-('' ).-'       ,'       ;
10.     '-;           |      .'
11.        \           \    /
12.        | 7  .__  _.-\   \
13.        | |  |  ``/  /`  /
14.       /,_|  |   /,_/   /
15.          /,_/      '`-'

Sasha Krassovsky的回复


当我查看在DigiPen上发现的一些随机学生游戏的源代码时,突然看到了以下内容:

/* Do NOT delete this comment */

自然,我必须查看删除评论后会发生什么。我删除了它并尝试重新编译。不工作。当我返回评论时,它就像魔术一样编译。

LNK1000出现错误:“未知错误;请参阅文档以获取技术支持选项。为什么必须发表此评论将永远是一个谜。

Rishi Kumar的回答


我见过的最好的东西是在一个复杂的程序中:

1. //Fu*k whoever wrote this shit

然后,大约五行之后:

//oh god it was me

陈旭的回复


一旦我看到这个:


1. //
2. //                       _oo0oo_
3. //                      o8888888o
4. //                      88" . "88
5. //                      (| -_- |)
6. //                      0\  =  /0
7. //                    ___/`---'\___
8. //                  .' \\|     |// '.
9. //                 / \\|||  :  |||// \
10.   //             / _||||| -:- |||||- \
11.   //            |   | \\\  -  /// |   |
12.   //            | \_|  ''\---/''  |_/ |
13.   //            \  .-\__  '-'  ___/-. /
14.   //          ___'. .'  /--.--\  `. .'___
15.   //       ."" '<  `.___\_<|>_/___.' >' "".
16.   //      | | :  `- \`.;`\ _ /`;.`/ - ` : | |
17.   //      \  \ `_.   \_ __\ /__ _/   .-` /  /
18.   //  =====`-.____`.___ \_____/___.-`___.-'=====
19.   //                       `=---='
19.   //
20.   //
21.   //  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.  //
23.  //            God Bless         No Bugs
24.  //

佛像祝福您的代码免受错误的侵扰。笑了一段时间。

来自Somnath Mishra的回应


曾几何时,我在Stackoverflow上看到了类似的主题,并且分享了我遇到的一些最有趣的评论。是的,我自己写了很多有趣的评论,但是出于明显的原因,我不会在这里分享它们。

这个评论不仅有趣,而且很棒。有些人在从事程序员工作时放弃了自己的文学梦想:

1. // Replaces with spaces the braces in cases where braces
2. // in places cause stasis                                                           
3. $str = str_replace(array("\{","\}")," ",$str);

(车道。在引起停滞的位置替换括号之间的空格)
英语听起来令人印象深刻-两行评论,其中有6个押韵词。

有点黑色幽默:

1. double penetration; // ouch

该代码可以使人成为无神论者:

1. //When I wrote this, only God and I understood what I was doing    
2. //Now, God only knows                                                  
3. // Update: I am an atheist now!

清理旧代码时,程序员经常会遇到一些未使用但不会删除的部分,以免可能造成后果:

1. // I am not sure if we need this, but too scared to delete.

恼火的程序员:

1. // I am not responsible of this code.
2. // They made me write it, against my will.

(车道。我对此代码不承担任何责任。他们强迫我违背我的意愿编写)。

愤怒的程序员:

1. // no comments for you
2. // it was hard to write
3. // so it should be hard to read

结论


该线程还有很多有趣的事情,您可以在此处阅读所有英语内容通常,如果发布此帖子,我认为稍后我将收集在我的实践中发现的最有趣的评论的列表。您遇到了哪些人?我很高兴阅读评论。

All Articles