Java註釋---基礎

1.前言

      我原本以爲註釋沒什麼好寫的，不就是“//”和“/**/”麼。直到我一次又一次的遇到下面類似的代碼，我才意識到自己又天真了一回。

@WebServlet(name="MyServlet",urlPatterns={"/my"})
public class MyServlet implements Servlet
{
  ...
}

      反正我沒看懂！接下來就進入正題了。這裏因爲註釋符號在博客編輯器中容易出現格式問題，所以在代碼裏進行說明。

2.文檔註釋

（1）註釋的插入

註釋以/**開始，並以*/結束每個/**...*/文檔註釋包含標記以及之後緊跟着的自由格式文本。標記以@開始，如@since或@param

（2）類註釋

類註釋必須放在import語句之後，類定義之前。下面是一個類註釋的例子
/**
A{@code Card}object represents a playing card...
*/
public class Card
{
 ...
}

（3）方法註釋

每一個方法註釋必須放在所描述的方法之前。處理通用標記之外，還可以使用下面的標記
@param variable description
這個標記將給當前方法的“parameters”（參數）部分添加一個條目。這個描述可以佔據多行，並且可以使用HTML標記。一個方法的所有@param標記必須放在一起。
@return description
這個標記將給當前方法添加“returns”（返回）部分。這個描述可以跨多行，並且可以只用HTML標記。
@throws class description
這個標記將添加一個註釋，表示這個方法有可能拋出異常。
下面是一個方法註釋的示例：
/**
Raises the salary of an employee
@param byPercent the percentage by which to raise the salary
@return the amount of the raise
*/
public double raiseSalary(double byPersent)
{
   double raise=salary*byPercent/100;
   salary+=raise;
   return raise;
}

（4）字段註釋

只需要對公共字段（通常指的是靜態常量）建立文檔。例如，
/**
The "Hearts" card suit
*/
public static final int HEARTS=1;

（5）通用註釋

標記@since text會建立一個“since”（始於）條目。text可以是引入這個特性的版本的任何描述。如，@since 1.7.1
下面的標記可以用在類文檔註釋中。
@author name
這個標記將產生一個“author”條目。可以使用多個@author標記，每個@author標記對應一個作者。
@version text
這個標記將產生一個“version”條目。這裏的文本可以是對當前版本的任何描述。
通過@see和@link標記，可以使用超鏈接

到現在還沒有解決開始的那個問題，那是一種註釋機制：註解。
因爲註解的接口很多，不太方便一一列舉出來，一般是需要的時候查閱文檔就行，這裏提供一個參考鏈接。
Java註解