Java的註釋和Javadoc在eclipse生成的方法 – Break易站

本文內容來自：Java的註釋和Javadoc在eclipse生成的方法 – Break易站

1.  Java的註釋

---

Java裏有兩種註釋風格。下面這個寫法是很是常見的

1 2 3 4

/*This is a comment *that continues *across lines */

還能夠寫成：

1 2	/*This is a comment that continues across lines*/

第二種寫法以下：

1	//This is one-line comment

2. Java的嵌入式文檔

---

一般，咱們把註釋和代碼都放到了同一個文件example.java裏面，這是爲了更好地維護Java文件的註釋，由於若是說明文檔和源代碼分開的話，每次修改源代碼以後，還要費力氣去維護說明文檔API。若是都寫在一塊兒，修改的同時，就能夠一塊兒維護了。

註釋和源代碼一塊兒看有時候會比較繁瑣，因此，JDK提供了給咱們一個提取註釋的工具javadoc。這個是可以在Java文件裏面提取對應的註釋，而且生成HTML文檔，以供咱們查閱的，很是方便。

那麼，咱們用eclipse怎麼樣提取javadoc呢，其實，就在eclipse的project裏面就可以自動提取javadoc了。project → Generate javadoc

而javadoc的一些標籤，能夠使咱們在註釋文檔和生成文檔API的時候顯得更加的專業，那麼，具體的標籤有什麼呢？請參照下面的表格,查看經常使用的javadoc：

本文內容來自：Java的註釋和Javadoc在eclipse生成的方法 – Break易站

---

—Author: Arvin Chen —Web Address: www.breakyizhan.com (Break易站)