eclipse怎麼寫文檔註釋

/步驟

先看默認狀態的吧，新建類文件時，是不生成註釋的

在

windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java file

編輯文件爲7的樣式，（爲了方便起見，中間分佈截圖說明，熟悉的朋友直接跳到7）

對於中文版本

窗口-->；首選項

java-->；代碼樣式-->；代碼模板

代碼-->；新的java文件

菜單欄，窗口——首選項

找到java選項-->；代碼樣式

註釋-->；新生成的java文件

直接編輯配置文件

在配置文件中間添加註釋代碼，這部分可以自定義，參考如下，關鍵字解釋見後文10

${filecomment}${package_declaration}/** * @author 作者 E-mail: * @date 創建時間：${date} ${time} * @version 1.0 * @parameter * @since * @return */${typecomment}${type_declaration}

現在新建文件將自動生成註釋

如何寫Java文檔註釋（Java Doc Comments）

本文翻譯自How to Write Doc Comments for the Javadoc Tool，但是精簡了一些私以爲不重要的東西

本文不討論如何使用javadoc工具自動生成文檔的方法，而是主要探討應該如何去寫文檔註釋

業餘時間整理，難免有遺漏或錯誤，如有發現歡迎指正

轉載地址：網頁鏈接

文檔註釋概覽

“文檔註釋”（Java Doc Comments）是專門爲了用javadoc工具自動生成文檔而寫的註釋，它是一種帶有特殊功能的註釋。

文檔註釋與一般註釋的最大區別在於起始符號是/**而不是/*或//。

比如：

/**這是文檔註釋*/

/* 這是一般註釋*/

// 這是一般註釋

在一些IDE（比如Eclipse）中，文檔註釋會以不同於普通註釋的顏色高亮顯示。

此外，文檔註釋只負責描述類（class）、接口（interface）、方法（method）、構造器（constructor）、成員字段（field）。相應地，文檔註釋必須寫在類、接口、方法、構造器、成員字段前面，而寫在其他位置，比如函數內部，是無效的文檔註釋。

文檔註釋採用HTML語法規則書寫，支持HTML標記（tag），同時也有一些額外的輔助標記。需要注意的是，這些標記不是給人看的（通常他們的可讀性也不好），他們的作用是爲了javadoc工具更好地生成最終文檔。所以，雖然有些標記寫起來麻煩且看着不直觀，還是要老老實實按規矩寫滴。

原文地址：網頁鏈接

所有javadoc 命令都只能出現於“/**”註釋中。但和平常一樣，註釋結束於一個“*/”。主要通過兩種方式

來使用 javadoc：嵌入的HTML，或使用“文檔標記”。其中，“文檔標記”（Doc tags）是一些以“@”開頭

的命令，置於註釋行的起始處（但前導的“*”會被忽略）。

有三種類型的註釋文檔，它們對應於位於註釋後面的元素：類、變量或者方法。也就是說，一個類註釋正好

位於一個類定義之前；變量註釋正好位於變量定義之前；而一個方法定義正好位於一個方法定義的前面。如

下面這個簡單的例子所示：

/** 一個類註釋 */

public class docTest {

/** 一個變量註釋 */

public int i;

/** 一個方法註釋 */

public void f() {}

}

注意javadoc 只能爲 public（公共）和 protected（受保護）成員處理註釋文檔。“private”（私有）和

“友好”（詳見5 章）成員的註釋會被忽略，我們看不到任何輸出（也可以用-private 標記包括private 成

員）。這樣做是有道理的，因爲只有public 和protected 成員纔可在文件之外使用，這是客戶程序員的希

望。然而，所有類註釋都會包含到輸出結果裏。

上述代碼的輸出是一個 HTML 文件，它與其他Java 文檔具有相同的標準格式。因此，用戶會非常熟悉這種格

式，可在您設計的類中方便地“漫遊”。設計程序時，請務必考慮輸入上述代碼，用 javadoc 處理一下，觀

看最終 HTML 文件的效果如何。

1、單行（single-line）--短註釋：//…… 單獨行註釋：在代碼中單起一行註釋， 註釋前最好有一行空行，並與其後的代碼具有一樣的縮進層級。

如果單行無法完成，則應採用塊註釋。 註釋格式：/* 註釋內容 */ 行頭註釋：在代碼行的開頭進行註釋。

主要爲了使該行代碼失去意義。 註釋格式：// 註釋內容 行尾註釋：尾端（trailing）--極短的註釋，在代碼行的行尾進行註釋。

一般與代碼行後空8（至少4）個格，所有註釋必須對齊。 註釋格式：代碼 + 8（至少4）個空格 + // 註釋內容 2、塊（block）--塊註釋：/*……*/ 註釋若干行，通常用於提供文件、方法、數據結構等的意義與用途的說明，或者算法的描述。

一般位於一個文件或者一個方法的前面，起到引導的作用，也可以根據需要放在合適的位置。這種域註釋不會出現在HTML報告中。

註釋格式通常寫成： /* * 註釋內容 */ 3、文檔註釋：/**……*/ 註釋若干行，並寫入javadoc文檔。每個文檔註釋都會被置於註釋定界符 /**。

*/ 。

分兩種情況的：

如果是javadoc的註釋：可以通過 alt+shift+ j

如果是 lisence：可以同個 code template實現

自定義註釋風格

Window->Preference 打開參數設置面板，然後選擇：Java -> Code Style -> CodeTemplates

可以看到Comments下面一系列可以註釋的Java代碼組成部分（對文件、變量、方法、構造方法、重載函數等等），比如我想定製Java文件的註釋風格，那麼在右側選擇Comments中的File項，點擊Edit，進入編輯模式，這樣就可以自定義註釋了。其中可以插入一些變量，如日期、文件名、作者等等。

Window-註釋的元素。

現就每一個元素逐一介紹：文件（Files）註釋標籤：/** * Copyright © ${year}公司名字. All rights reserved. * * @Title: ${file_name} * @Prject: ${project_name} * @Package: ${package_name} * @Description: ${todo} * @author: ${user} * @date: ${date} ${time} * @version: V1.0 */ 類型（Types）註釋標籤（類的註釋）：/** * @ClassName: ${type_name} * @Description: ${todo} * @author: ${user} * @date: ${date} ${time} * ${tags} */ 字段（Fields）註釋標籤：/** * @fieldName: ${field} * @fieldType: ${field_type} * @Description: ${todo} */ 構造函數標籤：/** * @Title:${enclosing_type} * @Description:${todo} * ${tags} */ 方法（Constructor & Methods）標籤：/** * @Title: ${enclosing_method} * @Description: ${todo} * ${tags} * @return: ${return_type} */ 覆蓋方法（Overriding Methods）標籤：/* （non Javadoc） * @Title: ${enclosing_method} * @Description: ${todo} * ${tags} * ${see_to_overridden} */ 代表方法（Delegate Methods）標籤：/** * ${tags} * ${see_to_target} */ getter方法標籤：/** * @return the ${bare_field_name} */ setter方法標籤：/** * @param ${param} the ${bare_field_name} to set */ 或者可以從網上下載配置好的.xml文件導入也可以。下載請點擊我！ PS：在按照上面的方法設置後，一定要到windows->Preferences->general->Content Types，右側Context Types樹，點開Text，選擇Java Source File，在下面的Default encoding輸入框中輸入UTF-8，點Update，則設置Java文件編碼爲UTF-8，否則會出現字符編碼的問題。

經過如上的設置後，就可以使用快捷鍵Alt+Shift+J來快速生成文檔的註釋了。使用方法如下：文件頭註釋：使用New->Class方法生成的文件會在創建類的對話框選項中提示是否生成註釋，默認是選中的。

這樣生成的.java文件就有在文件頭帶有上面設置的版權信息。若是使用New->File方法建立的java文件則不會自動生成文件頭的版權信息，必須手動輸入。

方法、類、字段等註釋：這一類的註釋只需要選中方法名、類名、或字段名，然後使用Alt+Shift+J來自動生成註釋，然後補全信息即可。望採納。