2009-09-26 75 views
11

JavaDoc有一個普通的Java API,帶有英文版和中文版,但似乎需要爲每個版本分別提供源代碼。有沒有更方便的方法來做到這一點?如何創建多語言JavaDocs?

+2

而你的問題是......究竟是什麼? – hjhill 2009-09-26 23:43:37

+0

@hjhill我編輯的問題,使其成爲一個實際的問題。 – 2014-01-05 09:34:15

回答

20

不,基本上沒有辦法做到這一點。

想到的唯一解決方法適用於生成的HTML頁面:您可以將JavaDocs環繞在使用CSS切換語言的塊元素中。試想一下:

/** 
* <div class="en">Documentation in English</div> 
* <div class="nl">Documentatie in Nederlands</div> 
*/ 
public void myFunction() {} 

隨後編輯JavaDoc中的CSS,使用戶可以切換語言,例如:

div.en { display:none; } 
div.nl { display:block; } 
+0

這是個好主意,謝謝。 – xrath 2009-09-27 01:03:40

+0

非常好的主意非常感謝!如何在JavaDoc中添加Javascript? – freddiefujiwara 2009-09-27 08:41:21

+0

我看到你已經收到你的問題的答案在這裏:http://stackoverflow.com/questions/1483141 – 2009-09-28 15:46:04

5

簡短的答案是否定的。現有的javadoc評論和工具不支持這一點。

我不認爲增加對源代碼中嵌入javadoc註釋的多個翻譯的支持是一個好主意。它不會是一個可擴展的解決方案:

  • 隨着每個新的翻譯被添加,源代碼文件變得更大。
  • 多語言描述將非常難以管理。

請考慮我是一名不讀/寫中文的API開發人員。當我更新英文javadoc時,我如何標示中文javadoc評論需要更新?我們如何處理潛在大量譯員需要更新源代碼文件並可能意外地將回歸引入實際代碼的問題?發佈經理如何確保所有翻譯都在「黃金」發佈之前完成?

我認爲一個更好的(假設的)解決方案是有一個修改後的javadoc工具,將javadoc註釋提取到版本數據庫中。然後編寫一個工具,當數據庫中的主要(如英語)javadoc評論發生變化時,該工具會提示注意事項,並提示技術編寫人員/翻譯人員對javadoc的中文,荷蘭語等翻譯進行相應更改。