1. 程式人生 > >什麼樣的文件能夠幫助理解程式碼

什麼樣的文件能夠幫助理解程式碼

  絕大多數人接收別人程式碼,第一句就是問,有什麼文件。這聽起來也是理所當然。所以不少軟體公司強調要寫文件。這裡其實有幾個問題,需要搞清楚:

  汝需要什麼樣的文件?估計聽了一愣:是啊,吾想要文件,可是什麼樣的文件好?

  假設作者寫的文件正確(這幾乎是不可能的),現在給了汝文件,汝能正確理解作者的意思?這個不好說吧?

  現在反問一句:別人要接手汝之程式碼,汝能提供什麼樣的確實有幫助作用的文件?這樣一問,估計所有人都傻眼了:是啊,吾天天要別人文件,現在別人要吾文件,吾……

  其實,程式碼是經常變動的,寫的人意思表達肯定不到位,讀的人更是雲裡霧裡。試圖寫一個有幫助的技術文件,至少吾沒有看到。

  那麼,是不是不要文件?當然不是。一個有幫助作用的文件,有一下內容:

  開發環境的搭建。

  範例的執行辦法。

  編譯註意事項。

  功能開關說明。

  關鍵流程示意圖。