1. 聚能聊>
  2. 话题详情

前端注释规范事件频发,你见过哪些奇葩的注释?

最近的“穷逼VIP”事件想必大家有所耳闻!详细的我就不说了大家可以去看看,当然了出于好奇,我在网上也看到了很多的奇葩的程序员写的注释来看看吧!

高富屌丝型程序猿

_2017_11_23_12_28_41

挨批受挫型程序猿

_2017_11_23_12_49_03

填坑吐槽型程序猿

_2017_11_23_12_50_56

言语混乱型程序猿

_2017_11_23_12_45_46

基情讲解型程序猿

_2017_11_23_12_46_33

BUG崩溃型程序猿

_2017_11_23_1_05_27

此乃天才型程序猿

96d2420f8e882af26b34fb2cb76b8217_hd

看了这么些奇葩搞笑的程序员,我想要说的是通过这件事中可以看到的问题那就是注释规范化,那我们来聊聊吧!

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。

2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。

3.和大家分享下你写代码的技巧可好。

4.你写没写过什么奇葩代码,说说。

内个!云栖社区评选票实在是少的可怜,拉个票投10号一票吧,谢谢各位https://yq.aliyun.com/promotion/430?id=people10

参与话题

奖品区域 活动规则 已 结束

  • 奖品一

    淘公仔 x 3

  • 奖品二

    虾米VIP月卡 x 3

  • 奖品三

    云栖社区T恤 x 2

90个回答

0

hikingx 已获得虾米VIP月卡 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
当个人独立开发时,谈不上代码规范,按照你个人的编程习惯即可。但是,如果是多人协作、共同开发一个项目,如果没有统一的代码规范的话,项目中的每个人都按照自己的习惯率性而为,就会导致整个项目的代码看上去杂乱无章,可读性非常差,并且持续增加后续的维护成本。
比如阿里官方Java代码规范标准《阿里巴巴Java开发手册》。

2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
这个注释写出的键盘,我服,忍不住都想去按下键盘。
screenshot

3.和大家分享下你写代码的技巧可好。
学习阿里官方Java代码规范标准《阿里巴巴Java开发手册》

4.你写没写过什么奇葩代码,说说。
还好,奇葩倒是没有。规规矩矩。

已经疯狂为你投票打call

hikingx 回复

公仔就这样跑了

巴洛克上校 回复
回复@hikingx:

这次没备注啊,下次吧备注下要啥,回答好的话就满足你

hikingx 回复

好的,多谢!

turman 回复

大佬们 厉害了。。

伍先生º 回复

真会玩!

伍建平 回复

两个都很重要

评论
3

夏之冰雪 已获得云栖社区T恤 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
很重要,可以让这个team组风格一致,大家互相协作更高效,编码也更清爽。
建议也有很多:

  1. 编辑器加入代码规范检测插件,很多编辑器都有。
  2. 公司要有代码规范指南,或者使用开源的,比如阿里java代码规范。
  3. 使用代码质量检测工具,对所有提交的代码,进行检测,比如sonar平台。
  4. 新人培训,加入代码和注释规范的环节。

2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
代码明明是自己写的,而注释作者一处,却写别人名字。

3.和大家分享下你写代码的技巧可好。
业务解耦,清爽的业务代码和丰富的注释相比,前者可读性更强。
每次为了bug修改代码,尽量加上注释予以说明。
不写没用的代码,避免写大量解释性的代码。
函数命名,变量命名,有时候就能很好表达是什么、做什么了。

4.你写没写过什么奇葩代码,说说。
之前,公司一同事接手一个图像生成的代码,很恼火。
由于生成的图像涉及位置计算、深度计算之类的,代码里到处都是数字。
最关键,这些公式里的数字,有的还是7.33这种,鬼知道是怎么来的。
然后,发现了好几处注释:
// this is magic number

以上代码,就是我写的。
后来那人问我,我说我就是不停地调整数字,然后看效果,再调数字,所以是magic number。

夏之冰雪 回复

想要个T恤~~~

评论
0

sinb520 已获得云栖社区T恤 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
答:我觉得代码/注释规范化是一项很重要的工作,尤其是对于需要团队协作的综合型项目,如果大家都按照自己的习惯写注释,必定会造成理解上的混乱,提高工作的难度,并且浪费大家的时间。要想代码规范的话,首先应该对团队的开发人员进行统一培训,但是还是会存在一些问题,毕竟每个人的习惯不同,最好的方式是给IDE开发一些规范插件,可以自动给出建议并选择修改。
2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
答:我一般都是在GitHub上研究别人的代码,注释都比较规范,要说奇葩注释的话,就是在CSDN上下载源代码时,有些注释是广告,要么就是随意的一段话。
3.和大家分享下你写代码的技巧可好。
答:我是一个有点强迫症的开发者,所以写代码的时候都很遵守规范,平时喜欢研究GitHub上一些大神的代码,了解他们的编程规范,最近又仔细研究了一下阿里巴巴公布的Java开发规约,觉得很有用。
4.你写没写过什么奇葩代码,说说。
答:刚学编程的时候,不知道怎么简单地判断,于是就用switch和case把所有几十种情况都一一列举出来进行处理,不知道算不算奇葩。
PS:每天打开云栖社区的第一件事,就是给上校您投票。如果可以的话,打赏一件T恤吧,O(∩_∩)O谢谢!

sinb520 回复

谢谢上校!继续支持上校,积极参与上校的话题讨论!

巴洛克上校 回复
回复@sinb520:

棒棒的

评论
1

一神杨庆民 已获得淘公仔 复制链接去分享

送子哥
1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
很重要,可以让这个team组风格一致,大家互相协作更高效,编码也更清爽。
建议也有很多:
编辑器加入代码规范检测插件,很多编辑器都有。
公司要有代码规范指南,或者使用开源的,比如阿里java代码规范。
使用代码质量检测工具,对所有提交的代码,进行检测,比如sonar平台。
新人培训,加入代码和注释规范的环节。
2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
代码明明是自己写的,而注释作者一处,却写别人名字。
3.和大家分享下你写代码的技巧可好。
业务解耦,清爽的业务代码和丰富的注释相比,前者可读性更强。
每次为了bug修改代码,尽量加上注释予以说明。
不写没用的代码,避免写大量解释性的代码。
函数命名,变量命名,有时候就能很好表达是什么、做什么了。
4.你写没写过什么奇葩代码,说说。
之前,公司一同事接手一个图像生成的代码,很恼火。
由于生成的图像涉及位置计算、深度计算之类的,代码里到处都是数字。
最关键,这些公式里的数字,有的还是7.33这种,鬼知道是怎么来的。
然后,发现了好几处注释:
// this is magic number
以上代码,就是我写的。
后来那人问我,我说我就是不停地调整数字,然后看效果,再调数字,所以是magic number。

1

海洋的云 已获得淘公仔 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
很重要。代码规范化除了是程序员自身的代码素质体现外,在进行团队合作时,可以避免很多不必要的玛法。而注释规范化对于个人而言,在回顾代码含义或者代码检查时,方便阅读,尤其是较早之前写过的代码。对于进行代码交接时,也方便后面的同事进行维护。最近发现阿里巴巴Java开发手册不错,可以参考下。
2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
听说过有程序员在代码注释里表白的,应该不算是奇葩注释吧~~
3.和大家分享下你写代码的技巧可好。
看过阿里巴巴Java开发手册,里面的内容不错,可以先学习下,再就是在看别人写的代码时,也会学习其中的优点。
其实最开始把代码写规范,把注释写好还是挺困难的事情,毕竟和自己的代码习惯不是很一致,而且有时候会感觉浪费时间,但是真的坚持下来的话,后期收获还是很大的,好的编码习惯,慢慢适应就好了。
4.你写没写过什么奇葩代码,说说。
谁没个曾经啊,不说,O(∩_∩)O哈哈~

公仔、公仔、公仔,谢谢~

1

浮生递归 已获得淘公仔 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
就跟写行政文书一样吧,言简意赅,但是这样少了点乐趣,让码字更枯燥了。加点调料感觉也挺好啊。轻松一下,工作更有效率。

2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
最奇葩的代码就是像文中的天才型程序员一样,没有注释!好吧,其实我也没有写注释的习惯。所以经常回头改自己几年前的程序时,因为本身就命名不规范,导致各种看不懂,真是各种坑自己。现在学乖了,宁可多打几个字,也要把命名给写清楚了。为了不用写注释。。。

3.和大家分享下你写代码的技巧可好。
坑多了,就感觉规范还是有必要的。具体的话,就看下阿里巴巴Java规范吧。

4.你写没写过什么奇葩代码,说说。
写过一次,当时只想着快,所有的类名、方法名称都只用了一个字母,这样写起来确实速度快了很多。各种sfa这样的。还不写注释。最后就自己也看不懂是什么的缩写了,尴尬了。

1

aoteman675 已获得虾米VIP月卡 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
这个得看项目是一个人开发还是团队开发,如果是团队开发,注释还是很有必要啦,一个人只要自己看得懂就行了,掌握核心代码,哈哈哈,老板不会炒鱿鱼
2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
注释全英文,看不懂
3.和大家分享下你写代码的技巧可好。
写代码讲究的是一气呵成,不能被打断。思路一段就得重写,除非有程序员鼓励师。
4.你写没写过什么奇葩代码,说说。
奇葩代码就是一个星期后自己都看不懂,命名脑子抽筋中文混合式开发

1

雷侠 已获得虾米VIP月卡 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。

重要,代码的质量和可读性非常的重要。
质量好的代码,看起来很舒服。
好的注释让人好理解这个东西是干嘛的。

多读书,多看报,少吃零食多睡觉。
不是,有Java代码规约插件嘛,还有代码规范的文档,都不错啊,支持看看。

2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。

最服的就是这一段代码

<a href="javascript:alert('清除成功')" >清除缓存</a>


6cf609126c79a3f70158afddc7e1e33c_r
3.和大家分享下你写代码的技巧可好。

经常看别人写的代码,再与自己比较就知道这个人是不是规范的代码。
还有查看文档和通过插件来改正自己。

4.你写没写过什么奇葩代码,说说。

初学java的时候,类名是中文的。Σ(|||▽||| )
是的,就是中文的。
后来知道这样写是不对的,然后就改正了。

雷侠 回复

如果,您觉得可以的话,就打赏一个虾米VIP吧。

评论
0

1305005110203438 复制链接去分享

ecs服务器网站访问速度慢具体都有有什么原因?

萧逸雨 回复

带宽

ezhixingli 回复

不错

浮生递归 回复

除了带宽不够还有程序写得不好,已经页面文件过大等

评论
1

伍建平 复制链接去分享

我不断给自己充电学习!就是为了未来接任新的使命!加油程序猿!未来是我的!

0

伍建平 复制链接去分享

马云一年做那么多慈善活动!#大家说是不是要给程序猿一点鼓励哈!残人需要关爱-常人需要关爱-难人需要关爱-男人需要关爱!

-1

1518612907297751 复制链接去分享

1.你觉得代码规范化/注释规范化,重要吗,有什么好的规范建议。
当个人独立开发时,谈不上代码规范,按照你个人的编程习惯即可。但是,如果是多人协作、共同开发一个项目,如果没有统一的代码规范的话,项目中的每个人都按照自己的习惯率性而为,就会导致整个项目的代码看上去杂乱无章,可读性非常差,并且持续增加后续的维护成本。
比如阿里官方Java代码规范标准《阿里巴巴Java开发手册》。
2.在工作中遇到过类似的奇葩注释吗,和大家分享下吧。
这个注释写出的键盘,我服,忍不住都想去按下键盘。

3.和大家分享下你写代码的技巧可好。
学习阿里官方Java代码规范标准《阿里巴巴Java开发手册》
4.你写没写过什么奇葩代码,说说。
还好,奇葩倒是没有。规规矩矩。
已经疯狂为你投票打call

0

帝都春哥 复制链接去分享

注释还是要清晰下,这样自己与团队成员看上去才会更清晰,增加工作效率

0

1365512620458760 复制链接去分享

作为一个甲方……我真的特别鄙视那些因为个人意气,对自己产品不负责任的情况,这样你是出气了,也给后续接手的同事以及产品使用方带来种种麻烦,达到了你的目的,但你的为人决定了你不会走上事业的任何高度,你的作品将成为你的口碑。曾经那个开发腾讯电商平台易迅网的CTo跟我们合作开发一个质保系统,结果里面的代码都是乱七八糟的套件,我就呵呵了,还创立了一个什么快CTO,辣鸡就是辣鸡。
0

三个蛋的猿 复制链接去分享

注释就是自己跟自己对话

0

张城铭最帅 复制链接去分享

这程序设计也是醉了

0

简学 复制链接去分享

前端代码的注释我觉得够用即可。

0

1304212143439339 复制链接去分享

什么意思

0

惠州阿庄 复制链接去分享

程序员书写代码应该需要一个良好的习惯,在平时中书写太随意了,造成看你代码的人非常痛苦,利已利人,程序需要标注!

0

1321912092104506 复制链接去分享

很好

5