2009-09-21 21 views
11

有沒有一種工具取代javadoc的東西,而不是正常的JavaDoc的HTMLish語法更多的Wiki風格的語法?是否有一個使用維基語法的javadoc替換?

我的一個問題是我大部分都是以源代碼的形式讀取JavaDoc。即使對於外部庫,我也嘗試添加源代碼,以便從我的IDE中導航到源代碼,檢查入口點上方的文檔以及下面的代碼。

另一個問題是,像列表和代碼示例這樣的東西很難寫,特別是如果你的IDE堅持要在每一行放上星星。我想看到的東西,用一種wiki語法與至少以下特點:

  • 名單
  • 代碼塊
  • 交聯方法/類

有還有很多更好的東西,但我相信這些都是必需品。

有誰知道這樣的工具?

+0

代碼塊都差不太多與'{@code}'。我認爲'{@link}'很適合鏈接到會員和類型。 – 2009-09-22 00:06:19

+0

當你在考慮維基風格的顯示時,如果你可以編輯維基風格,並且將它推回到評論中,那將是非常不錯的。我懷疑這是多少要求。 – Carl 2009-09-22 02:28:52

回答

3

有一個項目叫做WikiDoclet,我從來沒有用過它,但我很想看看你對它的看法。

從網站:

這是一個擴展,提供了Java JDK標準的Javadoc的doclet。它增加了對我所謂的Wiki格式化的支持。這意味着你的JavaDoc現在可以使用文本規則進行格式化,這些規則比嵌入在JavaDoc中的html更容易理解。例如,要強調一段文字,你用星號圍繞它。斜體字下劃線。當運行doclet以生成JavaDoc時,將對這些規則進行評估並進行html替換。這種格式化應該會使閱讀java源代碼變得更加容易,因爲它不再會與HTML標籤混雜在一起。這對於項目符號列表和表格尤其如此。 HTML仍然保留,所以你可以混合和匹配,只要你喜歡。

對於其它doclet,格式,請doclet.com

+0

不錯的鏈接 - 謝謝。我會給它一個鏡頭。 – 2009-09-23 04:42:31

相關問題