java - 如何创建多语言 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 注释需要更新？对于潜在的大量翻译人员需要更新源代码文件并可能意外地将回归引入实际代码的问题，我们该怎么办？发布经理如何确保在“黄金”发布之前完成所有翻译？

I think that a better (hypothetical) solution is to have a modified javadoc tool that extracts the javadoc comments into a version database. Then write a tool that that notices when a primary (e.g. English) javadoc comment changes in the databases, and prompts the technical writers / translators to make the corresponding changes in the Chinese, Dutch, etc translations of the javadoc.