1. 程式人生 > >Eclipse自動生成javadoc

Eclipse自動生成javadoc

javadoc
The JDK tool that generates API documentation from documentation comments.
Documentation comments (doc comments)
The special comments in the Java source code that are delimited by the /** ... */ delimiters. These comments are processed by the Javadoc tool to generate the API docs.
How to write Java doc comments

選中某個project, 然後選單 > project > generate javadoc

(Eclipse有個Jautodoc pulgin 可以為每個檔案自動生成comment)

Package Comment Files

Each package can have its own documentation comment, contained in its own "source" file, that the Javadoc tool will merge into the package summary page that it generates. You typically include in this comment any documentation that applies to the entire package.

To create a package comment file, you have a choice of two files to place your comments:

  • package-info.java - Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is new in JDK 5.0, and is preferred over package.html.
  • package.html - Can contain only package comments and Javadoc tags, no package annotations.

A package may have a single package.html file or a single package-info.java file but not both. Place either file in the package directory in the source tree along with your .java files.

package-info.java This file can contain a package comment of the following structure -- the comment is placed before the package declaration:

File: java/applet/package-info.java

/**

* Provides the classes necessary to create an applet and the classes an applet uses

* to communicate with its applet context.

* <p>

* The applet framework involves two entities:

* the applet and the applet context. An applet is an embeddable window (see the

* {@link java.awt.Panel} class) with a few extra methods that the applet context

* can use to initialize, start, and stop the applet.

*

* @since 1.0

* @see java.awt

*/

package java.lang.applet;


Note that while the comment separators /** and /* must be present, the leading asterisks on the intermediate lines can be omitted. package.html - This file can contain a package comment of the following structure -- the comment is placed in the <body> element:

File: java/applet/package.html

<HTML>

<BODY>

Provides the classes necessary to create an applet and the classes an applet uses

to communicate with its applet context.

<p>

The applet framework involves two entities:

the applet and the applet context. An applet is an embeddable window (see the

{@link java.awt.Panel} class) with a few extra methods that the applet context

can use to initialize, start, and stop the applet.



@since 1.0

@see java.awt

</BODY>

</HTML>


相關推薦

Eclipse自動生成javadoc

javadoc The JDK tool that generates API documentation from documentation comments. Docum

Eclipse中設置自動生成javadoc註釋

eth ram ref pos 分享圖片 pes ron bubuko methods 1)windows-->preference-->Java-->Code Style-->Code Templates-->code-->new Ja

Eclipse中設定自動生成javadoc註釋

轉自:http://jingyan.baidu.com/article/a501d80c09dab1ec620f5e4b.html http://www.cnblogs.com/fsjohnhuang/p/3988883.html windows-->preferen

eclipse自動生成getset註釋

setters ron ren 目錄 pla 設置 附件 註釋 consola 1、文件替換 將附件裏的文檔替換到eclipse安裝目錄下的plugins,在替換之前最好是把那個文件做個備份放在外面。 2、重啟Eclipse設置註釋風格: Window->Prefer

Eclipse自動生成 get/set

.com ras lun ahp v2v lips 3rd wkt air %E5%AD%97%E8%8A%82%E5%BA%8F%E8%BD%AC%E6%8D%A2%E4%B8%8E%E7%BB%93%E6%9E%84%E4%BD%93%E4%BD%8D%E5%9F%9F

Eclipse自動生成作者、日期註釋等功能設置

XP 生成 types create replace templates lan pro name 在使用Eclipse 編寫Java代碼時,自動生成的註釋信息都是按照預先設置好的格式生成的。 修改作者、日期註釋格式:打開Windows->Preferences-&g

eclipse 自動生成json格式的toString()方法

ring string com image other 分享圖片 自動 code The 文本代碼 {"${member.name()}":"${member.value}", "${otherMembers}"} eclipse 自動生成json格式的t

Eclipse自動生成POJO和Mapper之Mysql資料庫

根據資料庫,表自動生成POJO,Mapper.xml。 依賴的jar 包 配置檔案.xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PU

Eclipse自動生成API文件

  之前做過很多專案,總結了一些常用方法,現在想要把所有的方法集體維護起來,在新專案的時候直接使用,很便利。為了查閱方便,這裡把所有的方法生成文件,用到了Eclipse的自動生成java文件功能。 選擇“project”-“generate Javadoc“   選擇專案、

Java eclipse如何生成JavaDoc

如何使用eclipse生成javaDoc 生成package-info.java 新建包的時候勾選左下方的框框 將對文件的描述寫入此檔案中,具體的註解等尚未深究 右鍵選擇專案Export,選擇ja

eclipse自動生成get、set方法的文件註釋

最近有個專案,對文件註釋要求嚴格,每個get方法和set方法上都要有文件註釋。每次用eclipse自動生成get、set方法後,收到加註釋比較麻煩,幸運的是eclipse可以在生成方法時自動加上文件註釋

eclipse自動生成變數名快捷鍵

原創:http://blog.csdn.net/siphiababy/article/details/74179684 ctrl+2+L這個快捷鍵可自動補全程式碼,極大提升編碼效率! 注:ctrl和2同時按完以後釋放,再快速按L。 比如寫這句程式碼: Graphi

Eclipse自動生成mapper:Mybatis-Generator外掛的使用

在maven專案中使用 1.導包,版本是1.3.2,一定要對應,不然出錯了,很難找到問題,我用了1.3.6的版本,出了問題找了半天 //版本是1.3.2,一定要對應,不然出錯了,很難找到問題,我用了1.3.6的版本,出了問題找了半天 <mybaits.generat

Eclipse自動生成變數名宣告(按方法返回值為本地變數賦值)

 ctrl+2+L這個快捷鍵可自動補全程式碼,極大提升編碼效率! 注:ctrl和2同時按完以後釋放,再快速按L。 比如寫這句程式碼: Graphics g = image.getGraphics(); 只需要先寫方法image.getGraphics()  然後按c

玩轉Eclipse自動生成setter和getter方法

        我們在程式開發過程中,往往要編寫這樣的類:類的部分或者全部屬性不希望讓外部世界直接訪問,而不用public欄位修飾。這樣,方法呼叫成了訪問這些屬性的唯一途徑。JavaBean就是一個很好的例子,其嚴格遵守面向物件的設計邏輯,所有屬性都是private。對於任

Eclipse 自動生成maven project 修改web project version

問題一:當用Eclipse 生成 maven project 時 自動生成了 web.xml 檔案 開啟一看 發現還是 2.3 版本 有點坑了  所以 需要自己更改 解決方式:第一,開啟project的.setting 資料夾 修改org.eclipse.wst.commo

eclipse生成javadoc文件

javadoc.exe是自動生成java文件的小工具。在eclipse裡面可以很方便的使用這個小工具,主要有三個常見的入口 (1)File —> Export —> java —> javadoc  (2)Project —> Generate J

Eclipse 通過JPA自動生成註解實體

tools nts 完成 oracl orm pro 技術 nbsp 問題 hibernate是JPA最常用的實現之一,而且hiberante自身也對註釋語法進行了支持。現在再不用去看那一堆堆的XML映射了。而且eclipse還提供了從數據庫直接生成Entity Clas

eclipse中如何自動生成構造函數

技術 tor get src sin image super java 構造函數 eclipse中如何自動生成構造函數 eclipse是一個非常好的IDE,我在寫java程序的時候使用eclipse感覺開發效率很高。而且有很多的快捷和簡便方式供大家使用,並且能直接生成cla

Eclipse中設置在創建新類時自動生成註釋

nbsp 編輯 files img pac eclips bsp 自動 auth windows-->preference Java-->Code Style-->Code Templates code-->new Java files 編輯它 ${