不要忽视文档的力量

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

程序设计中文档的应用

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

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

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

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

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


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

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


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

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


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

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

文档才是你唯一的依仗。


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

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,901评论 25 709
  • 文章来自:http://blog.csdn.net/mj813/article/details/52451355 ...
    好大一只鹏阅读 13,010评论 2 126
  • 2017年03月10日 小雨: 学习: 跟读内容:《伤寒论》(二)辨太阳病脉证并治下第九;《庄子》5-04;《文学...
    磊蔡阅读 2,206评论 1 3