关于编程的一点感慨·代码缺乏生命

关于编程的一点感慨

写的代码缺乏生命力

  1. 过段时间自己看,都有些陌生。
  2. 缺乏:设计思路图文,文档类注释,测试样例代码。

工作中,有时要维护修改业务功能时,总想重写掉得了,反而好维护。
大抵也是代码缺乏生命的缘故,这些代码不能离开维护他的人
业务型的代码诞生之初一般不太考虑离开维护他的人。

设计图文

当代码量多时,一般都会在心中或者在纸上,有个大概的结构设计思路。
现在也仅仅有时写下些设计思路相关的注释,没有图文。

实际也在本子上画了些,但是没有保存到文档里。

注释

很少写注释,觉得麻烦。只在个人觉得要说明的地方写些自定义的注释。

有注意把函数名和参数名取的有意义。发现这时不够的,有些信息无法描述:

  1. 异常相关的信息
  2. 调用的约束
    1. 参数和返回值的范围
    2. 函数调用的外部条件
    3. 函数的一些特殊行为

google的代码注释详尽,格式规整,可用某某工具生成文档。注释的数量要和代码量差不多了。

两个工作里,都没有强调注释的规范。
想是业务性的代码更在乎快速出结果,业务代码都是谁写谁维护。

注释小结

  1. 业务代码:写点简单注释就够了。一般逻辑不复杂,都是在某个框架下,复制模式。
  2. 库代码:这种是把代码当成产品发出去的,需要详尽的文档。

测试代码

毕业进百度时还写过一段时间php的单元测试代码。
好麻烦,为了测试数据库部分,还要用个mock框架。测试代码比业务代码还多,感觉没什么收益。
当时就我这个刚入职的写了一段时间。

看luna的源码时,发现有专门写一套测试代码,而后在自己写脚本语言时也写了个。主要是对功能块的黑盒测试样例。
当修改代码时,运行测试可确保定义的行为没有改变。

google开源的代码普遍带有测试代码。

测试小结

  1. 业务代码:就不用写测试了,特别是单元测试,耗时费力收益小。
  2. 库代码:最好写一批模块黑盒测试代码,确保定义的行为一直正确。

后续看看要不要给子集写的几个基础库形式的代码加上测试代码。

异常处理

一般不处理异常的,把异常当Assert,直接抛出它让程序挂掉,处理的目的就是没有异常。

有些时候异常是要处理的,如给人用的编辑器。
写编辑器工具时,码那么多简单的测试输入的代码真是手酸。
业务性的代码差不多都是这样吧,各种检验输入。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,552评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,666评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,519评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,180评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,205评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,344评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,781评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,449评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,635评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,467评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,515评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,217评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,775评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,851评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,084评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,637评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,204评论 2 341

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,324评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,570评论 18 139
  • 持续做一件事情能带来什么样的威力? 持续锻炼身体,身体越来越健康,再胖的身体也能减肥成功! 持续写作,小白功底的作...
    骏马背上的小雨燕阅读 410评论 0 1
  • 肯德基请了鹿晗做代言,麦当劳请了吴亦凡代言。是麦当劳想搞事情,制造话题吗?如果答案是肯定的,也很正常,营销就是需要...
    whoogaoqiao阅读 342评论 0 0
  • 《小酒馆》 一两名掌勺, 三四间屋社, 五六张木桌, 七八碟土菜, 围坐九或十人。 待七八盏过后, 剩五六盘残羹,...
    时光清浅阿莲阅读 353评论 7 7