在編寫程序時(shí)，應(yīng)當(dāng)給程序添加一些注釋，用于說(shuō)明某段代碼的作用，或者說(shuō)明某個(gè)類的用途，某個(gè)方法的功能，以及該方法的參數(shù)和返回值類型和意義等。

很多初學(xué)者開(kāi)始學(xué)習(xí)編程語(yǔ)言時(shí)，會(huì)很努力寫程序，但不太注意添加注釋，他們認(rèn)為添加注釋是一件浪費(fèi)時(shí)間，而且沒(méi)有意義的事情。經(jīng)過(guò)一段時(shí)間的學(xué)習(xí)，他們寫出了一些不錯(cuò)的小程序，如一些游戲，工具軟件等。在經(jīng)過(guò)一段時(shí)間的學(xué)習(xí)，他們開(kāi)始意識(shí)到當(dāng)初寫的程序在結(jié)構(gòu)上有很多不足，需要重構(gòu)。于是他們打開(kāi)源代碼，以為可以很輕松的改寫源代碼，但這時(shí)他們發(fā)現(xiàn)理解原來(lái)寫的代碼非常困難，很難理解原來(lái)的思路。

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

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

程序注釋是源代碼的一個(gè)重要組成部分，對(duì)于一份規(guī)范的程序源代碼而言，注釋應(yīng)當(dāng)占到源代碼的1/3以上。……………………

轉(zhuǎn)載于:https://www.cnblogs.com/shengjie123/p/4438358.html

總結(jié)

以上是生活随笔為你收集整理的关于注释的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。