如何创建多语言JavaDocs？

Question

JavaDoc是普通Java API的英文版和中文版,但似乎需要为每个版本分别提供源代码.有没有更方便的方法来做到这一点？

Answer 1

不,基本上没有办法做到这一点.

想到的唯一解决方法适用于生成的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; }

Answer 2

最简洁的答案是不.现有的javadoc注释和工具不支持此功能.

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

• 随着每个新翻译的添加,源代码文件变得更大.
• 多语言描述将非常难以管理.

考虑一下我是一个不读/写中文的API开发人员.当我更新英文javadocs时,如何标记中文javadoc注释需要更新？我们如何解决潜在的大量翻译需要更新源代码文件并可能意外地将回归引入实际代码的问题？发布经理如何确保所有翻译在"黄金"发布之前完成？

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