标签: 注释
只给不常见的代码添加注释
我听到有人说注释应该解释原因,虽然这本身并没有 “错”,但我不记得这是我写注释的主要原因。下面是我在当前代码库中写的一些注释。这并不是我写的唯一一种注释,但这种风格与我听到的别人的建议有所不同。
那些代码里有趣的字母拼图注释
图示是最容易让人理解的表达方式,我们使用图片来认识问题。各种主流编程语言,从某方面来说,都使用了完全不同的编程理念或数据操作方法,给人们的认知留下了巨大的鸿沟。本文展示了一些嵌入在源代码中,使用字母排列拼出来是图案注释。我们很佩服这些注释!
趣图:优秀的代码注释
所有的程序员都应该以此为榜样
趣图:注释主要是用来干嘛的?
注释主要是用来干嘛的?5%是用来写注释,95%用来注释掉代码
关于自我注解的CSS代码的思考
Martin在文中详细讨论了代码注释,我不会完全重复他的话。简而言之,他的意思就是,这些注释是注定会过时的。程序执行时会忽视注释,所以无法保证这些说明注释会准确的描述代码作用。所以最好的方式是让代码自说明,如此,按照代码逻辑,程序员和程序获取到的信息是一致的。
从虾米音乐“穷逼VIP”事件说起,程序员对代码注释应该怎么看?
部分程序员认为,写代码是一个冗长且无趣的过程,不在代码注释里留下点吐槽、好玩的东西,对不起自己的千万行代码。所以,就有了各种各样或恶趣味、或啼笑皆非的代码注释。
阿里巴巴式程序员:超能力者为何在一行代码中写下阶层恶意?
在这些程序员的身上,我们看到的是,能力越大责任越小,而个人习性的劣根性反而暴露得越显著。
虾米音乐代码曝光:程序员吐槽赠送的VIP是“穷X”
原来,在写代码的时候,为了让同事看懂这串代码的作用,程序员会对这行代码进行注释。而在虾米音乐MAC客户端的代码注释里,一位发帖人看到了这行代码……
那些年我们写过的代码注释,没被打死真是奇迹!
曾经年少轻狂,写了三两行简简单单的逻辑代码,却总要在前头署上自己的大名,然后等到生产版本宕机那天,已经换了三四家的公司的你还是被无情夺命连环 Call 。曾经对面坐着的是个花一般的测试,然后代码的注释里,总是会多出好几排空格。曾经,我们在写代码时,还会有心情写注释。曾经,写注释时,身边还有你。望能博君一笑。
代码神注释,让我们认真对待一次!
前两天我在朋友圈看到有个人在说:“好的代码是可以自己解释自己的,所以我从来不写注释”。
神注释大全(欢迎补充)
写在前面的话:一时兴起就收集了以下神注释,希望能为广大ITer带来快乐,缓解你们工作中的压力,下面开车,先自爆头像,下文会给出制作链接。
雷人的代码注释-最后一张雷死人
雷人的代码注释-最后一张雷死人
程序员代码里神一般的图案注释,太逗了
扒扒程序员这么多年撸的代码里那些诡异的注释团,枯燥的程序代码也不乏可爱的一面,总有一款会惊到你,喜欢的欢迎评论处留言,教你如何写出这样的程序注释团并把源码发你哦。
10个令人喷饭的代码注释,你有没有遇到更绝的?
程序员最讨厌的10件事,0:写注释,1:别人不写注释。对于很多程序员来说,最讨厌别人不写注释。而有些人写出来的代码注释,通常拥有幽默搞笑的风格,看起来很有意思。今天为大家精选10个令人喷饭的代码注释,注意,看的时候千万不能喝水或者吃饭。
Python里的一些注释规范
学会注释是编码过程中不可或缺的一部分。那么什么样的注释才是规范的注释,才能让其他看你代码的人能快速的了解你得代码结构呢。我们今天就说一说 有关于Python的一些注释规范。
这样的代码才是好代码
好的代码,就像是好的笑话——无需解释就能让别人明白。如果你的代码能够做到不解自明,在大多数时候,你根本无需为其配备说明文档。
8个最没有意义的代码注释
多年来,我非常荣幸能和一些谦逊的公司和客户合作。我也因此有机会接触到各种不同的程序员—— 每个程序员都有自己独特的风格。事实上,每个项目本身都有一些独特的元素。
程序员应该避免的5种代码注释
你有没有这样的经历:别人审查过你的代码之后给出的注释,你认为是没有必要的?注释代码是为了提高代码的可读性,目的是为了能让其他人更容易理解你的代码。
什么时候应该避免注释代码?
看到标题,我知道你可能会想:“我为什么要避免代码注释,这难道不是一件好事吗?”。是的,写注释在大多数情况下是有用的。但是,请注意,我说的是“在大多数情况下”,因为有一些情况下,你不应该写注释。
Python 开发者节省时间的 10 个方法
Python 是一个美丽的语言,可以激发用户对它的爱。所以如果你试图加入程序员行列,或者你有点厌倦C++,Perl,Java 和其他语言,我推荐你尝试Python.
Haskell编程精华:什么时候该注释,什么时候不该注释
大家都知道,写程序时应该让程序易读易懂,而添加注释是让你的程序实现这个目标的好方法。然而,对于一个程序,并不是你添加了足够多的注释,它就能变得的易懂易读。事实上,第一要务是你的程序要写的干净整洁,这样也就没有添加注释的必要了。编译器是不会检查你的注释的,而注释往往会滞后于代码的更新,跟实际代码实现不一致。如果你打算要写一段注释,在你真正的动手写之前,请先思考一下下面的这些问题:
