java開發注釋模板導入（java注釋模板設置）

本文目錄一覽：

• 1、java中如何自動生成注釋
• 2、如何新建個java文件自動添加註釋
• 3、java的javadoc怎麼用？
• 4、idea 如何導入java注釋模板文件
• 5、如何在eclipse 中設置自動添加Javadoc注釋
• 6、eclipse怎麼設置創建一個java文件後自動加入注釋

java中如何自動生成注釋

你說的應該是生成javadoc吧?

最簡單方式就是使用命令行, cd到你的項目源代碼目錄下, 輸入如下指令:

javadoc -d docs -subpackages com.yourpackage

其中-d docs指定了生成的javadoc在相對目錄docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代碼包.

JAVADOC是官方提供的一種生成注釋文檔的工具, 他的用法如下:

用法: javadoc [options] [packagenames] [sourcefiles] [@files]

  -overview file                 從 HTML 文件讀取概覽文檔

  -public                          僅顯示 public 類和成員

  -protected                       顯示 protected/public 類和成員 (默認值)

  -package                         顯示 package/protected/public 類和成員

  -private                         顯示所有類和成員

  -help                            顯示命令行選項並退出

  -doclet class                  通過替代 doclet 生成輸出

  -docletpath path               指定查找 doclet 類文件的位置

  -sourcepath pathlist           指定查找源文件的位置

  -classpath pathlist            指定查找用戶類文件的位置

  -cp pathlist                   指定查找用戶類文件的位置

  -exclude pkglist               指定要排除的程序包列表

  -subpackages subpkglist        指定要遞歸載入的子程序包

  -breakiterator                   計算帶有 BreakIterator 的第一個語句

  -bootclasspath pathlist        覆蓋由引導類載入器所載入的

                                   類文件的位置

  -source release                提供與指定發行版的源兼容性

  -extdirs dirlist               覆蓋所安裝擴展的位置

  -verbose                         輸出有關 Javadoc 正在執行的操作的信息

  -locale name                   要使用的區域設置, 例如 en_US 或 en_US_WIN

  -encoding name                 源文件編碼名稱

  -quiet                           不顯示狀態消息

  -Jflag                         直接將 flag 傳遞到運行時系統

  -X                               輸出非標準選項的提要

通過標準 doclet 提供:

  -d directory                   輸出文件的目標目錄

  -use                             創建類和程序包用法頁面

  -version                         包含 @version 段

  -author                          包含 @author 段

  -docfilessubdirs                 遞歸複製文檔文件子目錄

  -splitindex                      將索引分為每個字母對應一個文件

  -windowtitle text              文檔的瀏覽器窗口標題

  -doctitle html-code            包含概覽頁面的標題

  -header html-code              包含每個頁面的頁眉文本

  -footer html-code              包含每個頁面的頁腳文本

  -top    html-code              包含每個頁面的頂部文本

  -bottom html-code              包含每個頁面的底部文本

  -link url                      創建指向位於 url 的 javadoc 輸出的鏈接

  -linkoffline url url2        利用位於 url2 的程序包列錶鏈接至位於 url 的文檔

  -excludedocfilessubdir name1:.. 排除具有給定名稱的所有文檔文件子目錄。

  -group name p1:p2..        在概覽頁面中, 將指定的程序包分組

  -nocomment                       不生成說明和標記, 只生成聲明。

  -nodeprecated                    不包含 @deprecated 信息

  -noqualifier name1:name2:… 輸出中不包括指定限定符的列表。

  -nosince                         不包含 @since 信息

  -notimestamp                     不包含隱藏時間戳

  -nodeprecatedlist                不生成已過時的列表

  -notree                          不生成類分層結構

  -noindex                         不生成索引

  -nohelp                          不生成幫助鏈接

  -nonavbar                        不生成導航欄

  -serialwarn                      生成有關 @serial 標記的警告

  -tag name:locations:header 指定單個參數定製標記

  -taglet                          要註冊的 Taglet 的全限定名稱

  -tagletpath                      Taglet 的路徑

  -charset charset               用於跨平台查看生成的文檔的字符集。

  -helpfile file                 包含幫助鏈接所鏈接到的文件

  -linksource                      以 HTML 格式生成源文件

  -sourcetab tab length          指定源中每個製表符佔據的空格數

  -keywords                        使程序包, 類和成員信息附帶 HTML 元標記

  -stylesheetfile path           用於更改生成文檔的樣式的文件

  -docencoding name              指定輸出的字元編碼

如何新建個java文件自動添加註釋

eclipse的話可以添加修改注釋模板，生成的文件就自動有了，一些類，方法可以快捷鍵生成

java的javadoc怎麼用？

Javadoc是Sun公司提供的一個技術，它從程序源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的API幫助文檔。也就是說，只要在編寫程序時以一套特定的標籤作注釋，在程序編寫完成後，通過Javadoc就可以同時形式程序的開發文檔了。

JBuilder提供了多項對Javadoc支持的功能，可以通過嚮導在工程窗格的樹中創建Javadoc的節點，通過節點的菜單命名創建工程的Javadoc文檔，可以通過誘導的方式錄入Javadoc的標籤，檢驗注釋是否和源代碼相匹配等。

本文，我們將講解如何在源代碼中用Javadoc標籤寫注釋及如何創建Javadoc文檔。

雖然軟體工程中把詳細設計作為軟體項目的一個重要的階段，但在實踐中往往沒有得到落實。並不是這個階段不重要，而是實施有很大的困難，因為軟體需求是天生的易動症患者，好不容易詳細設計出來後，需求已和當初的版本大相徑庭，而花費巨大，精雕細琢的詳細設計已變成昨日黃花了。

Javadoc注釋由Javadoc標籤和描述性文本組成，你可以為類、介面添加註釋，也可為構造函數、值域、方法等類中的元素添加註釋。

可以通過代碼模板快速的錄入Javadoc注釋，你也可以選擇通過Javadoc對話框以一種形象化的方式錄入Javadoc注釋。此外，JBuilder還提供了各種Javadoc的輔助功能，如JavadocInsight誘導錄入，衝突報告和更正，特殊的todo標籤等。

雖然在Java文件中編寫注釋後，馬上可以切換到內容窗格的Doc視圖頁代碼中對應的Javadoc文檔，但在Doc視圖頁中生成的文檔僅是不完整的”範本”。首先，沒有導航樹，其次沒有生成通過@see或@link關聯內容的鏈接。所以你可以把Doc視圖頁中的Javadoc文檔看成是Javadoc最終版本的預覽。

本文中我們介紹了Javadoc的標籤，講解了如何在JBuilder編輯Javadoc注釋，你應該盡量使用JavadocInsight、ClassInsight和ParameterInsight快速而正確地編寫Javadoc注釋。此外你應該將常用的注釋做成模板，方便快速錄入。

JBuilder提供的注釋衝突報告和恢復的功能可以使你輕鬆解決注釋衝突的問題，免除了單調的手工調整操作。

JBuilder還允許你自定義Javadoc標籤，以滿足一些個性化的要求。此外JBuilder自定義的todo標籤可以使你隨時隨地在需要的地方作上標記，不至於遺漏未盡的工作。

idea 如何導入java注釋模板文件

可以了解下idea的livetemplate，非常強大，idea可以將整個IDE的配置都導出來，然後導入

如何在eclipse 中設置自動添加Javadoc注釋

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

在

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}

——————我是分割線，別複製我———————————–

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

補充說明;

也許你看到我們在寫注釋文件時用到了很多關鍵字，那麼這裡我們就了解一下Javadoc

Javadoc是Sun公司提供的一個技術，它從程序源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的API幫助文檔。也就是說，只要在編寫程序時以一套特定的標籤作注釋，在程序編寫完成後，通過Javadoc就可以同時形成程序的開發文檔了

關鍵詞列表：

@author 作者名

@date 日期

@version 版本標識

@parameter 參數及其意義

@since 最早使用該方法/類/介面的JDK版本

@return 返回值

@throws 異常類及拋出條件

@deprecated 引起不推薦使用的警告

@see reference 查看引用

@override 重寫

更多Javadoc用法可以訪問：百度百科、官方文檔。

eclipse怎麼設置創建一個java文件後自動加入注釋

eclipse設置創建一個java文件後自動加入注釋的方法：

1、通過菜單 Window-Preference 打開參數設置面板，然後選擇：

Java – Code Style – Code  Templates

2、在右側選擇Comments,將其中的Files項，然後選右邊的”Edit”，進入編輯模式：   

3、進入編輯模式後就可以自定義注釋了。另外可以插入一些變數，如年、日期等等。

4、最後，確保 Code – New Java files 中有：”${filecomment}”