新闻中心

EEPW首页 > 牛人业话 > 万千代码,文档奈何只是几行淡墨

万千代码,文档奈何只是几行淡墨

作者:三昧道人时间:2018-11-16来源:电子产品世界收藏

佛法有云,诸法无性,尽随心转。白话就是,啥事都不要定性,太早下结论容易被打脸。要知道,心情变了,看法也就不一样了,比如婚前女友的叮嘱你只当可爱,到了婚后,老婆的叮咛便成了聒噪。其实,咱也不好骂这男人薄情,相见时难别亦难,东风无力百花残。当时过境迁,岁月摧残了红颜,就算咱情比金坚,柔情款款也早变成了柴米油盐。昨日难再回,往日不可追,既然地球无法停转,咱们又何必刻舟求剑!

本文引用地址:http://www.eepw.com.cn/article/201811/394464.htm

  1

  据说,程序猿平生最烦两件事,一则是别人要求他给自己编的写文档,二则是别人留下的没有留下文档。

  别人要求自己写文档这事吧,码农们大可傲娇地想:“我写的阅读性这么好,居然还要求老子写文档,多此一举,生命好宝贵,不可再浪费的好不好!”,而对于别人的代码没留文档这档子事呢,码农们却很是可以借此大发牢骚,“悲了个催的,写完代码,趁着热乎劲顺手写点文档又不耽误多大功夫,利人利己嘛!关键是这天杀的代码写得这么晦涩难懂,还好意思不留文档,真是不负责任之极也,xx**&&***!” 。

  都是大哥不说二哥,但聪明“绝了顶”的码农们难道意识不到,这是赤裸裸的五十步笑百步,典型的搞双重标准吗?难道其智商突然被溢出的情绪堆栈清了零吗?非也非也,在洒家看来,同行们一向智商出众,在写文档的事情上如此严于待人,宽于律己,实在是因为大多数人都喜欢写代码、讨厌写文档的缘故。何至于此,且听洒家娓娓道来。

  2

  还记得科比和凌晨四点的洛杉矶的故事吗?

  当年,一位傻白甜记者压抑着内心激荡不已的崇拜,问起横扫篮坛的科比:“你为什么能如此成功呢?”科比挺着被自信充胀起来的鼓囊囊的胸肌,反问道:“你知道洛杉矶凌晨四点钟是什么样子吗?”记者微微一笑,识趣地摇摇头:“不知道,什么样儿?”科比挠挠头,说:“满天星星,寥落的灯光,行人很少。”叨咕半天后,科比就像在念广告语一样,字斟句酌地说道,“十多年过去了,洛杉矶街道早上四点的黑暗仍然没有改变,但我却已变成了肌肉强健,有体能、有力量,有着很高投篮命中率的运动员。”然后,科比咧开嘴笑了起来,白白的牙齿,黑黑的脸庞,让他的笑脸显得格外灿烂。

  采访结束后的这天夜里,记者顶着因为经常熬夜赶稿而发黑的眼圈,喝着提神的苦咖啡,再一次站在窗台前,望着凌晨四点笼罩在一片黑暗之中的洛杉矶,苦苦思索着一个思考了很多遍但总是不得要领的问题:“头顶同一片天,脚踩同一方地,为什么科比穿梭在凌晨四点的洛杉矶,日复一日,十多年来乐此不彼,终于成就了当下的自己,而我却只想草草地写完稿子,早早地回家睡觉?”一念至此,他又想起了中国喜剧演员范伟在小品《卖拐》里的一句经典台词:“同样是人,差距怎么就那么大尼!”

  夜,愈发地深沉了,洛杉矶的凌晨异常寂静,好像罩着一层轻纱,被偶尔驶过的一辆汽车震颤一下,再度恢复平静。微风轻轻吹动记者头顶那日渐稀少的头发,送来一句弱不可闻的答案:“坚持早起,科比能年入数千万美金,而你却只能挣点可怜的稿费!!稿费。。。”

  明月如钩,将冷冷的月光洒在记者憔悴的脸庞上,他落寞地伫立窗台,像老牛反刍一样仔细咂摸着这句答案,一时间,竟不能自已,任凭风起如刀,吹落汩汩涌出到因多日繁忙未及修剪的胡须中的热泪,滴入仍然冒着热气的廉价咖啡中。

  相比之下,收入比记者更为悲催的呢?睡得比妓晚,起得比鸡早,只因娃娃要上各种辅导班,婆娘们要过美好生活,便只能强撑着加速老化的残躯,拿着微薄的收入,带着听诊器写代码,将心比心,我们又怎么忍心苛责码农们为什么不写文档呢?行文至此,四大不空的洒家竟然悲伤得不能自已,唉,唉,竟不知说啥好了。

  在诸多码农眼中,写文档,不写文档,工资标准就在那里,不高也不低。

  3

  天下熙熙,皆为利来,天下往往,皆为利往。做为万物之灵的人类一向是无利不起早,当然会自觉地选择利益最大化的工作方式。

  码农的工作就是写代码,让系统正常稳定地跑起来,既然写文档貌似不能多挣钱,谁不希望过着晃晃悠悠、又是一周的日子呢?干嘛自我加压,背上个写文档的苦差事?

  但是如果,写文档不仅有好处,而且好处大大滴呢?

  通过写文档表达设计思想、总结工作中的经验教训之类的老生常谈,洒家自然不屑再言,也无需多言。洒家想在这里分享给大家的,是在多年边写代码边写文档的职业生涯中体会到的货真价实的好处,细细说来,大致有三。

  4

  一则帮助快速修改代码。

  都说好事多磨,好代码也如是,需要反复多次打磨。据说在佛门中证了初果、得了道共戒的修行者“初果耕地,虫离四寸”,耕地时,自然而然地不会碰到田地中的虫子,也就不会犯杀戒。天才码农改代码时也差不多是这种境界,改起来行云流水,指哪打哪,自然而然地不会因为改了一处代码而影响了其它的地方。

  但是,群体中更多的是像洒家这样的平庸之辈,改代码时挂一漏万,互相牵连。经常是拆了东墙,倒了西墙,改了代码后,信心百倍地认为不会带来其它影响,但多次被无情的事实打脸。倘若有平时写代码时留下的文档,清楚地写明了模块之间的关联,这样的错误就会减少很多,工作更轻松不说,也保全了脸面不是?

  5

  二则帮助快速解决bug。

  在看《步步惊心》时,对于受尽康熙和雍正的打压、欺辱的胤禛,其实是没有多少同情心的,如果非要为这种冷血找一个原因的话,那就是,因为他是八阿哥-bug!

  Bug的存在难以避免,洒家平生所愿只是希望bug小一点,好对付一点。Bug的产生原因多种多样,最多的一种则是没有忠实严谨地实现设计,即“设计”思路本来没错,但是由于水平有限等诸多原因,并没有正确地“实现”它。此时,您是对着写给机器的代码,再绞尽脑汁地重新复现可能忘掉重要细节的设计思路,还是对着写给人的文档,顺着设计的脉络查找实现上的不严谨,哪种方式更轻松更有效,应该是一目了然了吧。

  6

  三则帮助快速写论文。

  天下论文一大抄,这句话在一定程度上反映了当前中国社会的生态,但也从另一个方面说明了写作素材的重要性。

  论文怎么这么难写?我想,每个等着靠论文指标评职称的人,都在其人生或早或晚的某个阶段,痛苦地思索过这个问题。论文的写作技巧千千万,抄袭、翻译等各种套路万万千,但是,巧妇难为无米之炊,对于不抄袭、不重复投稿的有志之士,素材、数据、资料才是论文最根本的下锅之米,而这些数据、素材靠的就是日常工作的日积月累,在文档中积淀着,专等着作者去挖掘。

  写文档有助于写论文,虽然只适用于需要发表论文评职称的一小撮科研人员,但是也并非别无用武之地。除了论文,还能发表博客、微信公众号文章,将经验分享出来,让更多的人看到,学习到,不也能为中华民族的伟大复兴贡献那么一丢丢的力量吗?

  代码万千,文档只是几行淡墨,这种局面应该得到改变了!



关键词: 代码 程序员

评论

技术专区

关闭