程序猿与注释的相爱相杀

日期:2018-06-11    阅读:450

程序猿作为地球上最为神奇的物种之一,干过不少惊天地泣鬼神的雄图大业,同样给人们留下了不少茶余饭后谈论的梗。在普通人们眼中,程序猿是神秘的,是不修边幅的,是没日没夜加班的工作狂;但在程序猿眼中,自己是帅气的,拯救世界的,一枝梨花压海棠的科技先驱。

程序猿的丰功伟绩,最直接的体现就是像艺术品一样的代码,行云流水、一气呵成。但不是所有的程序猿都能看懂别人写的代码,就像不是所有的人都会欣赏艺术品一样。毕竟代码是用于业务生产,为了让别人能够更好理解自己的作品,也为了让自己能够更深刻的记住创作艺术品的过程,程序猿对自己的作品进行了加工——注释。
注释,顾名思义,就是对代码进行释义。注释不是写给机器的语言,不参与到代码的编译、连接、工作中去,而是写给人看的内容。众所周知,代码,是让计算机按照人的预想进行工作,注释并没有让代码运行得更加快,那么注释到底扮演者什么样的角色呢?程序猿和注释之间又有怎样的故事呢?


注释是什么?

注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性
为什么写注释?

1.好记性不如烂笔头
用于业务生产的程序,通常都不是寥寥几语了事,而是大篇大篇的代码,更有甚者,代码行数千万级别。虽说现在编程语言越来越高级、方便,对程序员越来越友好,大大缩小了代码行数,但功能全面的、性能稳定的代码依然有不小的篇幅。程序员在写代码的时候,语法规则虽然不难、不多,但是参数、函数、变量等等自定义的元素依然有很大的变化。代码再有规则,但毕竟不是人类语言,不能一眼看明,再加上篇幅巨大,难免会有写了后面往前面的尴尬处境。再加上前后代码写的时间有差异,程序员想要记住自己所写的所有函数、变量、参数,也是很困难的。与其花时间记住这些函数、参数,不如一行注释来得更快。



PHP-小星星-广州:曾经,一个东西,写的时候思路清晰,然后半年后愣是没看懂。


PHP-Coeus-安徽:别说半年了,我上周写的一个方法,现在都已经不知道上周开了什么脑洞。


写代码要和写注释同步进行,对作品进行阐述,这样不但可以预防写后忘前的尴尬处境,还能让自己的创造思路更加清晰。


古人云:好记性不如烂笔头。


2.我为人人,人人为我
书写篇幅巨大的代码是一个宏伟的工程,这样的工程通常不是一己之力能够完成,众人拾柴火炎高,众人划桨开大船。谈及到协同工作,首先要一个共同的标准,艄公多了打翻船的道理大家都明白。

Web-白杨-郑州认为:一般立项的时候有规范文档,对象、函数声明一系列都要求一致。


但每一个程序员对艺术的理解不一样,创造艺术品的方式和过程也会大相径庭。但大家都是一起干活,工期到了拿不出产品难免又要被工头教训。


程序员:“怎能让自己的艺术屈服于生活,简直是侮辱。”
工头:“好好好,听你的,只要你不写 :(){ :|:& };: (fork炸弹)。但是你总得让你的小伙伴能和你一起干活吧,你的小伙伴得知道你干了啥是吧。”
程序员:“那我写好注释,他们就能领悟到我的艺术了吧。”
工头:“小伙子不错,觉悟很高,中午盒饭加鸡腿。”



PHP-Coeus-安徽:注释写的多少、写的是否详细,也影响了使用、修改你代码的人员的门槛。


为了更好的协同开发,和小伙伴能够一起愉快的玩耍,写一个清楚明白的注释是非常重要的,相爱没有那么容易,每个程序员有他的怪癖。如果每一个参与到项目开发中的程序员都能将代码用心写好,这无疑是协同开发一个利好因素。而且,你的注释也会让对你代码顶礼膜拜的初学者获益匪浅。


古人亦云:我为人人,人人为我。


3.前人栽树,后人乘凉
维护过别人代码的程序员,都应该经历过一种切肤之痛——因为没有注释或者注释不清楚而导致完全无法理解这代码。宿迁网络公司的艺术品,接盘侠的毁灭日。


创作者眼中的代码
接盘侠眼中的代码


其实这并不夸张,因为编程语言的特点,每位艺术大师都有足够的发挥空间,但天马行空的想象确实会让后人难以琢磨。简直就是前人栽树,后人吃土的节奏。


谁也不想看到这样的代码,单单是要看懂就废了九牛二虎之力,分分钟吐血的节奏啊。


程序员:“我去,这段代码什么意思?这个调用是想干嘛?哪里又冒出来这么个玩意儿?老板,我想死。”
工头:“想死都不行,你知道该怎么写代码了么?”
程序员:“我知道了,我一定要写好注释,为以后的工作铺平道路。”
工头:“嗯嗯,小伙子很有远见,看来以后是要接我的班了。”
程序员:“我接了你的位置,那你呢?”
工头:“我去做产品经理。”
程序员:“。。。。。。。。。。。。。。。。”


写好注释,会为业务的发展和程序的迭代提供不少便利,谁都不想当接盘侠,那就谁也别做隔壁老王。


古人还云:前人栽树,后人乘凉。


当前IT行业的发展趋势,系统的迭代、程序的重构、工作的交接、对新进宿迁网络公司人员的培训等事情越来越多,这些事情无一例外都会把已经写过的代码重新或者重复阅读,如果在初始编写代码时,就做到完整、清晰明了的代码注释,对后续工作会有巨大的帮助。不仅提高工作效率,还能加固小伙伴之间的友谊。事实上,就算只是自己看自己的代码,如果有注释,也能加深印象,缩短代码查找时间。因此,任何开发人员,都应该养成良好的代码注释习惯。

Copyright © 2015 宿迁灵感软件有限公司  | 保留公司所有权利 | 苏ICP备13038063

新闻动态  |  网站建设  |  网站优化  |  网站案例  |  联系我们  |     |  返回首页  |