如何创建多语言JavaDocs？

Question

普通的Java API有英文版和中文版的JavaDoc，但似乎每个版本都需要单独的源代码。有没有更方便的方法来做这件事？

Answer 1

不，基本上没有办法做到这一点。

唯一的变通办法适用于生成的HTML页面:您可以将JavaDocs包围在块元素中，这些块元素使用CSS在不同语言之间切换。考虑一下：

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

Answer 2

简短的回答是否定的。现有的javadoc注释和工具不支持这一点。

我认为在源代码中添加对嵌入javadoc注释的多个翻译的支持不是一个好主意。这将不是一个可扩展的解决方案：

• 随着每个新翻译的添加，源代码文件变得越来越大。
• 多语言描述将很难管理。

假设我是一个不会读/写中文的API开发人员。当我更新英文javadoc时，我如何标记需要更新中文javadoc注释？对于潜在的大量翻译人员需要更新源代码文件并可能意外地在实际代码中引入回归的问题，我们该怎么办？发布经理如何确保所有的翻译都在“黄金”发布之前完成？

我认为更好的(假设的)解决方案是有一个经过修改的javadoc工具，它可以将javadoc注释提取到一个版本数据库中。然后编写一个工具，当数据库中的主要(例如英语) javadoc注释发生变化时通知该工具，并提示技术作者/翻译人员对该javadoc的中文、荷兰语等翻译进行相应的更改。