【问题标题】:How to provide the javadoc in other languages? [duplicate]如何提供其他语言的 javadoc? [复制]
【发布时间】:2011-03-24 07:10:49
【问题描述】:

我们经常与在西班牙、智利、印度等其他国家/地区开发和维护的服务集成。我经常看到来自西班牙和智利的服务/API 调用使用西班牙语。但是我们希望我们的代码是英文的,Javadoc 是英文和西班牙文的。我正在寻找实现这一目标的最佳方法。

对于这种场景是否有一个公认的通用标准?

以下是西班牙特有的第二姓示例。 getLastName() 对于说英语的人来说已经足够清楚了,但是这个 API 也暴露给说西班牙语的人,因此我添加了一个 Javadoc,如下所示。

     /**
     * Segundo Apellido
     */
    String getSecondLastName();

【问题讨论】:

  • 除了复制和粘贴代码然后翻译它以生成单独的 Javadocs 之外,我没有看到其他选项。

标签: documentation internationalization javadoc


【解决方案1】:

this stacloverflow 问题中讨论了一个可能的问题。可能会有所帮助。

【讨论】:

    【解决方案2】:

    本身没有约定,但您需要做的是使用这样的 doclet:

    http://sourceforge.jp/projects/sfnet_l10ndoclet/

    Sun 过去常常按需提供其内部本地化 doclet 的源代码,但我不会在这上面打赌:

    http://java.sun.com/j2se/javadoc/faq/index.html#localizationdocletsh

    就我个人而言,我建议尽可能以单一语言记录,并在必要时为非母语人士编写大量解释性说明。如果您认为有必要,请投资于开发人员的外语技能——它迟早会得到回报。

    【讨论】:

      【解决方案3】:

      使用 l10ndoclet

      • 从源代码生成带有待翻译文本的 XML 文件

      • 从源文件和翻译文件生成本地化文档

      【讨论】:

        猜你喜欢
        • 2012-09-04
        • 2011-04-06
        • 1970-01-01
        • 2017-09-11
        • 1970-01-01
        • 2011-04-04
        • 2010-10-13
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多