在編寫程序時，應當給程序添加一些注釋，用于說明某段代碼的作用，或者說明某個類的用途，某個方法的功能，以及該方法的參數和返回值類型和意義等。

很多初學者開始學習編程語言時，會很努力寫程序，但不太注意添加注釋，他們認為添加注釋是一件浪費時間，而且沒有意義的事情。經過一段時間的學習，他們寫出了一些不錯的小程序，如一些游戲，工具軟件等。在經過一段時間的學習，他們開始意識到當初寫的程序在結構上有很多不足，需要重構。于是他們打開源代碼，以為可以很輕松的改寫源代碼，但這時他們發現理解原來寫的代碼非常困難，很難理解原來的思路。

為什么要添加程序注釋呢？至少有如下三方面的考慮：

• 永遠不要過于相信自己的理解能力
• 可讀性第一，效率第二
• 代碼即文檔

程序注釋是源代碼的一個重要組成部分，對于一份規范的程序源代碼而言，注釋應當占到源代碼的1/3以上。……………………

轉載于:https://www.cnblogs.com/shengjie123/p/4438358.html

總結

以上是生活随笔為你收集整理的关于注释的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。