如何在其他语言中提供javadoc?

时间:2010-08-02 15:59:14

标签: documentation internationalization javadoc

我们经常整合在西班牙,智利,印度等其他国家开发和维护的服务。我认为西班牙和智利的服务/ API电话是西班牙语。但是我们希望我们的代码是英语和Javadoc都是英语和西班牙语。我正在寻求实现这一目标的最佳方法。

这种情况是否有共同的公认标准?

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

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

3 个答案:

答案 0 :(得分:2)

使用 l10ndoclet

  • 从包含待翻译文本的源代码生成XML文件

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

答案 1 :(得分:1)

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

答案 2 :(得分:1)

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

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

Sun曾经根据需要为其内部本地化doclet提供源代码,但我不打赌它的房子:

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

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

相关问题