javadoc

14熱度

1回答

格式化的JavaDoc我想使用的JavaDoc風格： /** * Description. * * @param param1 parameter description * @param param2 parameter description * @return return description. * @throws exception exception descri

0熱度

2回答

確定javadoc是否遇到任何錯誤或警告

我想確定從makefile發出的javadoc命令是否遇到任何錯誤或警告。目前，我可以看到，由於導入語句不在我們指定給javadoc（但應該是）的類路徑中，所以我們遇到了錯誤。我最終想修復我們的javadoc調用和內容，然後鎖定它，以便任何錯誤或警告將被makefile捕獲並停止構建。但是，據我所知，文檔沒有提到javadoc命令返回的任何代碼值。請注意，我們使用Java 7並從GNU makef

0熱度

1回答

有沒有一種方法來說明將應用於Javadoc中的方法參數的更改？

想象一下將更改應用於參數化對象的方法。例如傳遞一個map或oder列表。如果開發人員決定不創建並返回參數的副本我想最好在Javadoc中註明此方法和指示這些更改的參數。我可以考慮像@varparam或@refparam這樣的替代@param標籤（關於其他編程語言的引用關鍵字）。問題是：在Javadoc中有沒有常見的方法來做這些提示？對參數進行更改有多普遍？我想這可能是一個經常出現的問題。

4熱度

1回答

如何將Java doc作爲類的不變量？

我想知道評論應該去哪裏以及我應該使用哪個關鍵詞，因爲我似乎無法在網上找到示例，我應該舉例說明嗎？ /** * @invariant invariant example */ public class Example { }

0熱度

1回答

無法在Eclipse上打開聲明（未找到源代碼） - HttpServlet.class

我試圖在Eclipse Neon.1上打開聲明（Mac OS X）。打開其他類，如PrintWriter.class工作正常，但當我打開httpServlet.class的聲明。無法找到來源。下面是我正在努力的截圖。我已經搜索了這個問題，但我找不到解決方案。請幫忙。

0熱度

1回答

的IntelliJ的JavaDoc @see

我在的IntelliJ很新。我的IntelliJ並不突出在評論@see。看起來像IntelliJ沒有看到@see作爲JavaDoc關鍵字，但我無法弄清楚如何改變它。這是正常的，還是可以解決這個問題？

0熱度

1回答

@version％I％，％G％和git

我已閱讀，你可以用你的javadoc以下和你的源代碼控制是爲了替換版本信息的變量... @version %I%, %G% 我試用了我的Maven項目，但魔法沒有發生。我該如何使用Git和我的springboot maven項目進行這項工作？感謝

0熱度

2回答

JavaDoc中是否需要作者標記？

無論常見慣例/最佳做法（因爲我知道很多人嘲笑@author是不好的做法），而是依靠官方消息來源，是否需要JavaDoc中的@author標籤？調查此問題，我查看了Oracle自己的文檔http://www.oracle.com/technetwork/articles/java/index-137868.html（這也是Google搜索'javadoc標籤'時的第一個結果）。在一個叫「標籤順

0熱度

1回答

在Maven中整合了外部jar依賴關係的javadoc URL

我已經搜索過類似的問題，但大部分都與有關使用javadoc生成所有包含的依賴關係的新java文檔。我的問題是更基本的 - 我只是想用「Ctrl +空格」或懸停在對象/方法時，可以查看Javadoc文檔在Eclipse中的外部庫。例如：我有一個依賴的「公地（CLI）」庫 <dependency> <groupId>commons-cli</groupId> <artifac

1熱度

1回答

如何找到javadoc可執行文件的版本？

我原以爲javadoc可執行文件會提供一個-v或--version選項，可以打印出可執行文件的版本。大多數可執行文件似乎都提供了這個。例如，GNU make讓你輸入gmake --version。即使javac有一個-version選項可顯示此信息。但javadoc的-version選項屬於@version段落，其-verbose和-help選項不顯示javadoc可執行文件版本。這是一個疏忽嗎？