代码中的注释作为一种自我表达的方式

最近,在选择一个不太流行的框架时,我遇到了以下代码。


因为杀手机器人爱独角兽!

我不知道作者想表达什么想法和心情,但是这使我想到:我们有多少次不完全按照他们的意图使用评论? 减少了一些发现。

  //如果您不喜欢星期二的星期五帖子,则不建议阅读。 

关于代码注释的话题有不同的看法。 有不言自明的代码的拥护者。 根据此概念,变量和函数应尽可能完整地命名,这在许多情况下无需编写其他注释。 其他人则喜欢在注释中描述每个步骤,以帮助自己以及以后需要使用代码的人。 有些人在一排写三层结构,而根本不评论它们(我承认我犯了这种错误)。 但是还有其他情况。

悲伤的表白


您是否曾经写过自己讨厌的东西? 您是否知道这样做是件坏事和丑陋的事,但情况(例如客户要求)比您强? 其中一些事情发生了。

  //这段代码很烂,您知道并且我知道。
 //继续,稍后再叫我一个白痴。 

这段代码令人作呕,您知道,我也知道。 继续前进,然后称我为白痴。

  //我对此代码不承担任何责任。
 //他们让我违反了我的意愿写了它。 

我对此代码不承担任何责任。 我被迫写这封信。

  //我必须找到更好的工作 

是时候找到更好的工作了

  //我将所有这些代码(我的所有工作)献给我的妻子达琳,后者 
 //一旦得到,必须养育我,我们的三个孩子和狗 
 //向公众发布。 

我将所有这些代码和所有工作都献给了我的妻子达琳(Darlene),他一看到日光就必须照顾我,我们的三个孩子和那只狗。

有时,用于编写代码的公司标准会迫使您做一些不适合开发人员内部逻辑的事情。

  const int TEN = 10;  //好像10的值会波动... 

好像值10可以变化...

我想起了一个案例,当时我在自由职业者的一个目录上做了一小部分工作。 交互系统以复杂的方式构建,因此没有来自客户的直接反馈。 尽管从代码的角度来看这很丑陋,但是有必要做“如图所示,因为客户如此批准”。 您也遇到过这些吗?

警告和知识丢失


碰巧最好不要干扰某些代码。 不要尝试重构,优化或以其他方式进行改进。

 / * *您可能认为您知道以下代码的作用。  *但是你没有。 相信我  *弄弄它,您会度过许多不眠之夜*诅咒您认为自己很聪明的那一刻*足以“优化”下面的代码。  *现在关闭此文件,然后开始其他操作。  * / 

在您看来,您似乎知道后续代码的作用。 事实并非如此。 相信我 进入它,您将度过许多不眠之夜,诅咒当您认为自己足够聪明以至于“优化”它的那一刻。 现在关闭此文件,然后再玩其他游戏。

  / *
  *亲爱的维护者
  *
  *完成尝试“优化”此例程后,
  *并且您已经意识到那是一个可怕的错误,
  *请增加以下计数器作为警告
  *给下一个家伙。
  *
  * total_hours_wasted_here = 73
  * / 

亲爱的随行人员! 当您完成“优化”此过程的尝试并意识到此错误的严重性时,请增加随后的计数器,作为对那些来您的人的警告。

  //魔术。 请勿触摸。 

魔术。 请勿触摸。

  / *
经过几个小时的咨询,谷歌的书
我发现这是由未知力量的意志
如果没有下面的一行,则IE7认为6px = 12px
 * /
 font-size:0px; 

经过数小时的咨询和谷歌搜索,我发现由于未知部队的意愿而没有后续路线,IE7认为6px = 12px

  //自动生成,请勿编辑。 所有更改将被撤消。 

自动生成的,请勿编辑。 所有更改将被丢弃。

顺便说一句,后者是与尝试进入您的代码的斗争中一个聪明的有趣例子。 他们说这有效。

痛苦与绝望


您是否需要处理一些导致您完全绝望的事情? Xee图像查看器的开发人员遇到了PSD格式的解析。 但是,如果没有注释,程序员可以与谁分享他的苦难? 下面是翻译,原文在github上

在这里,我想停下来谈一谈Adobe PSD格式。 PSD并不是一种好的格式。 PSD甚至不是坏格式。 称其为侮辱其他不良格式,例如PCX或JPEG。 不,PSD是一种可怕的格式。 花费了几周的时间编写此代码,使我对PSD的仇恨达到了烈火般的水平,以一百万个太阳的强烈热情燃烧着。

如果有两种方法可以做某事,则PSD在不同的地方使用。 另外,他还将创建三种明智的方法,这是任何明智的人都不会发生的,并同时使用它们。 PSD使艺术水平变得不一致。 例如,为什么他决定这些块应按四个字节对齐,而这种对齐应该包含在大小中? 其他位置的其他块要么不对齐,要么大小对齐。 但是,此处未包括在内。 这三种方式中的任何一种都可以。 合理的格式应侧重于一种。 PSD当然会同时使用所有这三个。

试图从PSD文件中提取数据就像在一个古怪的叔叔的阁楼上寻找东西一样,他在58岁生日时死于疯狂的淡水鲨的袭击。 最后的细节对这个故事而言并不是特别重要,但此刻我花了大量时间为文件格式中负责此Rub Goldberg的人们介绍有趣的命运。

之前,我尝试获取最新的PSD格式规范。 为此,我不得不求助于他们,让他们考虑是否可以向我发送这本神圣的著作。 该过程包括将某些文件的副本传真给他们,可能是鲜血签名。 我想到的唯一解释是过程的复杂性-他们为产生这种可憎性而感到as愧。 自然,我无法执行此过程,但是,如果可以的话,我会将所有内容打印到此规范的单个页面中并进行刻录。 如果可以,我将收集世界上所有规格的副本,然后将它们直接发送给太阳。

PSD不是我最喜欢的格式。

我没有达到如此仇恨的程度,但是我想起了阅读一些国内开发人员的API文档时眼睛流血的感觉。

娱乐自己的方式


我们知道程序员的工作是多么无聊和孤独。 因为有时候我们每个人在KVN中玩同一个人。 当然,最安全的方法是在注释中,但是有一些选择。

  #圣诞树初始化器  
     toConnect = []  
     toRead = []  
     toWrite = []   
    素数= []  
    回应= {}  
    剩余= {} 

圣诞树初始化器

  ////////////////////////////////////// 

好评论行

 重覆
     ...
直到(JesusChristsReturn)'不确定 

宗教教条有疑问...

  //如果我再次看到这个,我将开始使用枪支 

我会再次看到这一点-我将开始携带武器进行工作

  //放弃所有希望超越这一点的人 

放弃希望大家进来

  //喝醉了,以后再解决 

以后喝醉修复

开个玩笑,然后我在监视器的贴纸上给自己留下类似的音符:“醒醒-检查XXX,YYY班级” ...

  catch(例外e){
  //谁在乎?
 } 

谁在乎?

  //我不理解以下内容的工作原理,但在我从中偷走的程序中却能正常工作。 

我不知道这是怎么工作的,但是在我偷的地方它在程序中起作用。

  //此代码是由天才编写的,因此请勿尝试通过
 //您的小脑袋。 

这段代码是由一个天才编写的。 不要试图用您的微型大脑来理解它。

 双重渗透  //哎呀 

真的,哦...

  //添加是因为老板改变了主意:20020111,20020501,20020820,...
 //由于老板改变了主意而被注释掉:20020201,20020614,20020908,... 

由于添加 老板改变了主意。 老板改变了主意...

  //哈利路亚,我可以回家! 

阿雷路亚,我可以回家

我回家了 您告诉我们您最难忘或最有趣的评论是什么。

感谢您与我们在一起。 你喜欢我们的文章吗? 想看更多有趣的资料吗? 通过下订单或将其推荐给您的朋友来支持我们, 为我们为您发明的入门级服务器的独特模拟,为Habr用户提供30%的折扣: 关于VPS(KVM)E5-2650 v4(6核)的全部真相10GB DDR4 240GB SSD 1Gbps从$ 20还是如何划分服务器? (RAID1和RAID10提供选件,最多24个内核和最大40GB DDR4)。

戴尔R730xd便宜2倍?在荷兰和美国,我们有2台Intel Dodeca-Core Xeon E5-2650v4 128GB DDR4 6x480GB SSD 1Gbps 100电视(249美元起) 阅读有关如何建立基础架构的信息 使用价格为9000欧元的Dell R730xd E5-2650 v4服务器的上等课程?

Source: https://habr.com/ru/post/zh-CN420091/


All Articles