程式註解如何寫

偶然的情況下，當我在搜尋寫作材料時，發現了這個網頁 Source Code Comments 收集了十二則，來自不同書刊、不同人物，對如何寫程式註解的看法。內容囊括了 為什麼要寫註解?

• 註解的作用方式。
• 怎麼寫
• 種類
• 內容
• 風格、流派 各個層面。 裡面也包括了一些相左、衝突的看法。例如，有些人認為程式碼本身就說明瞭一切，只要選定好的變數、函數等名稱，程式碼本身就足夠了。另一方面也有人提倡把所有的東西都寫進程式碼的註解裡，讓程式碼儘可能的詳盡。

寫註解，其實是一個值得探討的題目，也一直是許多程式設計師心中的痛。好奇的是，國內的程式設計師養成單位，似乎對這個議題都只是輕輕帶過，只對學生說「註解很重要」，其它就沒了。或許又是一句老話，「 學校的老師們大多不寫程式吧!! 」。