多言語JavaDocsの作成方法は？

Question

英語版と中国語版のJava APIのJavaDocがありますが、版ごとに別々のソースコードが必要なようです。これを行うもっと便利な方法はありますか？

Answer 1

いいえ、これを行う方法は基本的にありません。

念頭に置いて唯一の回避策は、生成されたHTMLページに適用されます。CSSを使用して言語を切り替えるブロック要素でJavaDocsを囲むことができます。考えてみましょう：

/** 
* <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; } 

Answer 2

短い答えはノーです。既存のjavadocコメントとツールはこれをサポートしていません。

javadocコメントの複数の翻訳をソースコードに埋め込むためのサポートを追加することをお勧めします。

• 新しい翻訳が追加されるたびに、ソースコードファイルが大きくなります。
• 多言語の記述は管理が非常に困難です。

私は中国語を読み書きしないAPI開発者だと考えてください。英語のjavadocsを更新すると、中国のjavadocコメントを更新する必要があることをどのようにフラグを立てることができますか？潜在的に多数の翻訳者がソースコードファイルを更新する必要があり、誤って実際のコードに回帰を導入する可能性があるという問題についてはどうしますか？リリースマネージャは、「金」リリースよりも前にすべての翻訳が確実に行われるようにしますか？

javadocのコメントをバージョンデータベースに抽出する修正されたjavadocツールが、より良い（仮説的）解決策になると思います。次に、データベース内で主な（例えば英語の）javadocコメントが変わったときに通知するツールを書いて、テクニカルライター/翻訳者にjavadocの中国語、オランダ語などの対応する変更を加えるように促します。