註解 的存在

註解 的存在

註解 的存在

註解 的存在

一個註解存在的時間越久,事實就越來越偏離當初的程式
碼解釋,也可能完全是個誤導。原因很簡單,因為程式設計
師沒有如實地維護它們。

程式碼會被修改和演化,程式區塊會被搬來搬去,有時候被
分離,有時候被重製,有時候又重新結合在一起。不幸的是
,註解無法每次跟著一起移動,沒辦法永遠跟著移動,於是
太常看到註解和它原本要解釋的程式碼分開了,變成孤單的
段落,準確性也一再地降低。

請把力氣花在讓程式變得更清楚易懂,這樣一來,從一開始就
不需要註解的存在。真相永遠只存在於一個地方,程式碼。只
有程式碼能忠實地告訴你它的作用,它是唯一準確的事實來源。