美文网首页
不要忽视文档的力量

不要忽视文档的力量

作者: 龙曜 | 来源:发表于2016-04-07 22:20 被阅读8次

软件是计算机系统中与硬件相依存的另一部分,软件包括程序、数据及其相关文档的完整集合。

程序设计中文档的应用

在实际工程中,我们很容易忽视文档的书写,这主要带来了以下问题:

1. 提高了程序的阅读门槛;

2.加大了测试和代码维护的成本;

3.对进一步优化算法造成了阻碍;

而在这个软件项目规模持续提高,工程师之间协作需求也进一步提高的环境下,这些缺点是很致命的。

达到工业标准的程序设计,对很多人,甚至小型公司来说都是一句空谈,

其中关键,我想正在于流程的规范化不足。

当然,很多人会站出来或者在心底里反驳我,对于大多数人而言,开发效率第一。

是的,对大多数人而言,提到文档,多半都认为可有可无。

对此,我不知道是该赞叹于他们出色的编码成功率,还是惊讶于他们编码经验的稀缺。

当你在测试一组数据而不知bug的由来时,当你debug不知从何做起时,

文档才是你唯一的依仗。

因此,我强烈建议,在实现的同时建立你的文档和你的版本控制,

这样,在你最恐慌的时候,才能有所依仗。

最好,你没有如此感谢它们的这一天。

相关文章

  • 不要忽视文档的力量

    软件是计算机系统中与硬件相依存的另一部分,软件包括程序、数据及其相关文档的完整集合。 在实际工程中,我们很容易忽视...

  • 不要忽视小力量

    为什么千里之堤会毁于蚁穴?为什么坚硬的岩石比不过点水?这些都是“小”的作为,“ 微”的力量,由此看来,我们不能忽视...

  • 不要忽视语言的力量

    一位黑人出租车司机载了一对白人母子,孩子问妈妈:“为什么司机伯伯的皮肤和我们不一样?” 母亲微笑着回答说:“上帝为...

  • 不要忽视行动的力量

    大家好,我是鲍鲍。 在开始之前,问大家一个问题,你会开车吗?会的可以在公屏区打出777…我看到有很多小伙伴都打了7...

  • 不要忽视坚持的力量

    我们每个人每天拥有同样的时间,但是结果却相差甚远,为什么呢?因为我们对时间的投入,专注力,目标感是不一样的。 我们...

  • 不要忽视他人的力量

    说到“他人”,很容易想到工作伙伴、家庭公司、还有社群学习,特别是兴趣群,群友友们互相勉励,实现共同发展。 在《活着...

  • 不要忽视精神的力量

    近期由于疫情的原因 ,很多儿女不想让父母出门,但有些人还是不幸中招了。 有的儿女为了不让父母出门,就会夸大疫情的严...

  • 不要放大自己,忽视了平台的力量

    不要放大自己,忽视了平台的力量 人生犹如演出,平台的力量不可忽视,切莫忘记脚下的舞台。 1,演出需戏台,人生要平台...

  • 请不要忽视语言的力量

    这几天发生了好多事,尤其是微博上,很多内容都不能辨其真假,但是看到那些狠毒的字眼的时候,还是难免有一些寒心。 我还...

  • 请不要忽视那些细微的力量

    生活中,我们总是大大咧咧,总会忽视那些细微的东西,细节。总觉得细微的东西起不了任何作用,也妨碍不了你什么。...

网友评论

      本文标题:不要忽视文档的力量

      本文链接:https://www.haomeiwen.com/subject/ycvtfttx.html