為何要寫注釋?

2022-01-13 10:14:35 字數 676 閱讀 2123

看到很多人喜歡寫注釋,當然也有很多人不喜歡寫。

很多人喜歡寫複雜的文件,甚至做了漂亮的來說明問題,花了相當大的精力去文件上面。

為什麼?

寫文件又不能執行,對不?

寫文件的作用我想主要是用來整理思路。人類的智力有限,尤其是記憶力有限,因此需要很多外部儲存體來幫助我們緩衝「中間資料」。

做文件的人都是聰明人,任何時候,寫文件都比寫程式要容易得多,因為文件可以容錯,格式可以自由。

文件也有乙個要求,那就是你對編碼要有信心,如果你寫得文件和編碼能力差太遠,根本無法實現文件描述的東西,或者文件描述的東西不是實際編碼所能做到的事情,這種編碼能力低下導致的錯誤文件,再漂亮也是沒意義的。

因此,不編碼,寫文件,反而對編碼能力是乙個考驗。這可能就是為什麼新手不喜歡寫文件,因為根本心中無碼,不知道寫的東西能不能和程式對上號來,寫了也等於白寫,乾脆就不寫。

解決編碼能力不足的問題,除了經驗積累沒有什麼好的方法。但是有很多人,對編碼已經較為熟悉了,還是不願意寫文件,因為自信自己能夠「直接」解決問題,也就不屑於寫文件。但是你要明白,你「直接」解決問題,實際上也必然是先構建思路,然後編碼,只是你把思路放在腦海裡,沒有存檔罷了。這造成的後果是將來自己都看不明白自己的**。文件並不費勁,文件只是將思路存檔的過程,讓一些模糊的觀點得到加強的過程,這是一種解題技巧,就如我們小學時候在紙上畫算式,畫示例圖,這些工具彌補了我們記憶力不足的缺點。

我們為何要寫CSDN部落格?

突發奇想,反問自己這麼個問題!最近專案發展加速,面試了好大一批人,果然是畢業季,來面試的人還真不少一般的多。幾天面試下來,發現了乙個特別有意思的事情,簡歷上有各種部落格的童鞋,技術管面試印象普遍不錯,要不是參與面試的人太多,真還就面試官一眼定終生了,哈哈 看來寫部落格對技術童鞋來說是乙個不錯的選擇,...

軟體設計的哲學 第二十章 為什麼要寫注釋

目錄 內文件在軟體設計中起著至關重要的作用。注釋對於幫助開發人員理解系統和有效地工作是必不可少的,但是注釋的作用遠遠不止於此。文件在抽象中也扮演著重要的角色 沒有注釋,就無法隱藏複雜性。最後,編寫注釋的過程如果處理正確,實際上將改進系統的設計。相反,如果沒有良好的文件記錄,好的軟體設計就會失去很多價...

為什麼要寫部落格?

一直想堅持寫部落格,但是總是以各種理由推脫,今天下決心果斷邁出第一步,下決心以後堅持寫,希望大家監督!為什麼開始寫部落格?1.對自己所學的知識進行歸納整理,可以促進思考,有益於加深對知識點的理解記憶,也便於以後快速複習掌握 2.積累下自己的經驗的同時分享給有需要的人,幫助後來者少走彎路 3.寫作是記...