不要忽視文檔的力量

軟件是計算機系統(tǒng)中與硬件相依存的另一部分,軟件包括程序、數(shù)據(jù)及其相關(guān)文檔的完整集合。

程序設(shè)計中文檔的應(yīng)用

在實際工程中,我們很容易忽視文檔的書寫,這主要帶來了以下問題:

1. 提高了程序的閱讀門檻;

2.加大了測試和代碼維護的成本;

3.對進一步優(yōu)化算法造成了阻礙;

而在這個軟件項目規(guī)模持續(xù)提高,工程師之間協(xié)作需求也進一步提高的環(huán)境下,這些缺點是很致命的。


達到工業(yè)標準的程序設(shè)計,對很多人,甚至小型公司來說都是一句空談,

其中關(guān)鍵,我想正在于流程的規(guī)范化不足。


當然,很多人會站出來或者在心底里反駁我,對于大多數(shù)人而言,開發(fā)效率第一。

是的,對大多數(shù)人而言,提到文檔,多半都認為可有可無。


對此,我不知道是該贊嘆于他們出色的編碼成功率,還是驚訝于他們編碼經(jīng)驗的稀缺。

當你在測試一組數(shù)據(jù)而不知bug的由來時,當你debug不知從何做起時,

文檔才是你唯一的依仗。


因此,我強烈建議,在實現(xiàn)的同時建立你的文檔和你的版本控制,

這樣,在你最恐慌的時候,才能有所依仗。

最好,你沒有如此感謝它們的這一天。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,346評論 25 708
  • 文章來自:http://blog.csdn.net/mj813/article/details/52451355 ...
    好大一只鵬閱讀 9,376評論 2 126
  • 2017年03月10日 小雨: 學習: 跟讀內(nèi)容:《傷寒論》(二)辨太陽病脈證并治下第九;《莊子》5-04;《文學...
    磊蔡閱讀 326評論 1 3

友情鏈接更多精彩內(nèi)容