2012-01-11 90 views
3

如何將Java文檔添加到.JAR文件,以便人們使用我的JAR文件並鍵入'。'。 Eclipse將顯示可用API(智能感知)的文檔。Java API文檔

更多信息

我有Java文檔創建,但是當我出口的JAR文件在其他項目中使用時,它不包含智能感知。這是我遇到的麻煩。

UPDATE 僅當導出源時才顯示智能感知。但是我想隱藏源代碼。我怎樣才能解決這個問題?

+1

[Writing JavaDocs](http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html) – jere 2012-01-11 15:21:41

+0

添加Java文檔可能會有幫助。它曾經與Netbeans一起工作,不知道它是否會在Eclipse中。 – npinti 2012-01-11 15:22:05

回答

3

如果你不想包含整個源代碼和你的.jar,你可以壓縮/ jar只是javadocs(但是你生成它們..我使用Project-> Generate Javadoc菜單選項蝕)。最終用戶可以將它們「附加」到項目構建路徑設置中的引用庫中。

項目庫的javadoc位置屬性可以是URL,本地目錄或本地存檔文件。

在注意到您的編輯之後,我可能想提到Ant有一個javadoc task,它可以在構建過程中生成您的javadoc。

2

Maven有一個非常優雅的處理方式。

步驟1:行家方式生成的javadocs:http://maven.apache.org/plugins/maven-javadoc-plugin/

步驟2:向確保的Eclipse總是重視這些文檔,使用maven-eclipse-plugin

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-eclipse-plugin</artifactId> 
    <configuration> 
     <downloadJavadocs>true</downloadJavadocs> 
    </configuration> 
</plugin> 

一旦這些兩個步驟完成後,您的API罐的消費者將始終擁有最新的javadoc,而無需進一步干預

0

在Eclipse中,導出包含源的項目。

做文件 - >導出 - >爪哇 - > JAR文件 - >下一步

然後選中複選框導出Java源文件和資源。

然後繼續,直到創建JAR。

編輯:在問題編輯之後,此答案不再有效,但仍然有用。