12

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

4

2 に答える 2

22

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

頭に浮かぶ唯一の回避策は、生成されたHTMLページに適用されます。CSSを使用して言語を切り替えるブロック要素でJavaDocを囲むことができます。検討：

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

続いて、JavaDocsのCSSを編集して、ユーザーが言語を切り替えられるようにします。例：

div.en { display:none; }
div.nl { display:block; }
于 2009-09-26T23:49:17.340 に答える
5

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

ソースコードに javadoc コメントの複数の翻訳を埋め込むためのサポートを追加するのは良い考えではないと思います。それはスケーラブルなソリューションではありません:

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

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

より良い (仮説上の) 解決策は、javadoc コメントをバージョン データベースに抽出する修正された javadoc ツールを用意することだと思います。次に、主要な (英語などの) javadoc コメントがデータベースで変更されたときに通知し、テクニカル ライターや翻訳者に中国語、オランダ語などの javadoc の翻訳に対応する変更を加えるよう促すツールを作成します。

于 2009-09-27T00:19:21.947 に答える