首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

看见同事在代码注释中骂领导,要不要删掉再提交 ?

大家好,我是东哥。

最近,刷到一个特别有意思的事,有网友吐槽,看见同事在代码注释中骂领导

于是,他发帖问大家:“要不要删掉再提交?”

其实我觉得,你首先得晓得这段代码是干嘛的?这段注释的意义是什么?删除了会有什么影响?

说实话,我个人觉得这句代码真的很牛 i  = 0x5f3759df - ( i >> 1 )  ,算是求平方根倒数(1/√x)算法的核心,i 被右移一位,之后与魔术常数 0x5f3759df 相减,这一步骤神奇地给出了平方根倒数的一个初始近似值,提升了计算速度

我个人猜想,有可能 “what the fuck”只是赞赏这句算法,而贴出代码的同事误以为在骂领导,后台我查了一下该算法大概由上个世纪90年代的硅图公司开发出来,后来出现在John Carmark的Quake III Arena的源码中,该算法主要用于3D图形渲染和游戏开发中。

其实关于这个算法的讨论,我之前在stackoverflow上也刷到过?但是别人聚焦在算法为啥快4倍的问题上?

感兴趣的小伙伴可以去了解一下,快的原因数据寄存器的范畴,因为在浮点和整数寄存器之间切换会导致负载命中存储,而浮点单元可以硬件执行倒数平方根。

说实话,工作后,关于算法的研究大部分程序员都会减少,但你的知道Java的那个库及开源组件里面有相应的算法实现,而不是自己去发明轮子

好了,我们接下来说说注释这个话题。

我以前带团队发现,有些小伙伴写代码的时候不爱写注释,有一次评审代码的时候,我专门找到一段没有注释的代码,让写这段代码的小伙伴再来给大家讲讲这段代码,他也一脸懵逼,这里不存在针对于谁,只是想表达注释还是挺重要的。

我个人觉得对于注释来说,还是要写得,毕竟来说,我们天天要写那么多代码,写好注释的好处在于,某天回过头来看自己的代码,不至于一脸懵逼!

关于在注释中骂人,我觉得这个就过了,基本的职业修养我们还是要有的,毕竟职场上吐槽归吐槽,工作归工作,把个人情绪带入工作中,总归是不太好的。

再者说了,你的注释在评审代码的时候,还是会被领导看到的,为何要给自己找不痛快呢!

就像网友说的那样,别没事找事,没锅背刚给自己找锅背,不认识的同事看到了就当没看到,关系还不错的提醒一下让他自己做决定删不删,你也算是尽了兄弟之义了。

说到这里,咱们再聊个有趣的话题。

在注释甚至在代码中说脏话,会不会影响总体代码质量呢?

还真有人做了这个研究。

Jan Strehmel,一名德国卡尔斯鲁厄理工学院的学生,发表了题为《开源代码中的脏话与代码质量相关性研究》的论文。

在此研究中,Strehmel从GitHub上收集了3800个含有脏话的代码库和7600个无脏话的代码库,使用了他们开发的分析工具SoftWipe对这些代码库的编码标准遵循情况进行评分。

Strehmel运用了多种统计方法如中心极限定理、Bootstrap方法、显著性测试、Jarque-Bera检验、Shapiro-Wilk检验、Q-Q图以及Kolmogorov-Smirnov检验等,以确保结果的统计学有效性。

经过详细的分析和对比,他得出了一项意外的发现:

包含脏话的开源代码明显比不含脏话的质量更好!

说实话,看到这个结论,我也惊呆了

也许在某些情况下,程序员们在写代码时情绪激动,反而会更加仔细和认真地检查代码,确保其正确性。

当然,这并不是鼓励大家在代码中使用脏话,但这个研究结果确实让人思考。

这里我还要补充一点,代码注释不仅仅是给自己看的,更多时候是给团队其他成员和未来接手项目的人看的。

专业的代码注释不仅能帮助团队更高效地协作,还能提升整个团队的技术水平。

我建议大家还是以专业的态度去对待工作中的每一个细节。毕竟,代码是团队协作的产物,每个人都应该对自己写的每一行代码负责。

  • 发表于:
  • 原文链接https://page.om.qq.com/page/Ovl0SKpL01t9b6Oeq9c4Exyg0
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券