軟件是計算機系統(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)的同時建立你的文檔和你的版本控制,
這樣,在你最恐慌的時候,才能有所依仗。
最好,你沒有如此感謝它們的這一天。