8.6 注釋及嵌入文檔

注釋對于讀懂程序起著不可缺少的作用，一個程序的可讀性是否好，關鍵就是注釋。對于一個程序的二次開發(fā)而言，要想讀懂前面的程序代碼，首先要在程序中有大量的注釋文檔。

本節(jié)將介紹如何對代碼進行注釋。通過實例來證明注釋在開發(fā)工作中的重要地位。前面曾經(jīng)提到過注釋，讀者也許印象不太深，這里也算復習一遍。

8.6.1 如何添加注釋

如何添加注釋呢？一般使用下面的方法。

/＊＊
包名引用
＊/

這個是類和包、方法的注釋，下面將詳細地介紹這些注釋。

8.6.2 類、方法等注釋的方法

在這一小節(jié)中，將簡單地介紹類、方法、字段等的注釋方法，雖簡單但是很重要。

1. 類注釋

類注釋一般必須放在所有的“import”語句之后，緊靠在類聲明之前。

/＊＊
this is the student class .
it includes the student name.
＊/
public class student
{
...
}

2. 方法注釋

方法注釋必須緊靠在方法聲明的前面，除了/**...*/標簽外，還可以使用下列的以@開始的標簽。

?@param變量描述

?@return返回類型描述

?@throws異常類描述

如果以上的注釋都沒有，把程序拿給別人看，別人會輕易看懂嗎？如果過了很長時間以后，自己再來看看這些程序，可能也已經(jīng)忘記這些代碼是做什么的了。

所以說，注釋對于程序的可讀性來說，是非常重要的，希望讀者不要忽視它，以免造成無可挽回的損失。