代码之家 › 专栏 › 技术社区 › Aravind Yarram

如何提供其他语言的javadoc[[副本]

javadoc internationalization documentation

Aravind Yarram · 技术社区 · 14 年前

对于这种情况有一个共同的标准吗?

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

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

3 回复 | 直到 14 年前

Community CDub 8 年前

本文讨论了一种可能的方法 this 斯泰克洛夫流问题。可能会有帮助。

hellboy Justin Pihony 14 年前

codehead 14 年前

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

Sun曾经为其内部本地化doclet按需提供源代码,但我不会把赌注押在它身上:

就我个人而言,我建议尽可能用一种语言记录,必要时为非母语人士写大量的解释性说明。如果你觉得有必要的话,投资开发人员的外语技能——这迟早会有回报的。

推荐文章

Alvaromon · 如何使用ReSharper获取C#样式的三斜杠注释++

7 年前

Shepmaster Tim Diekmann · 如何基于功能标志有条件地执行模块级doctest?

7 年前

depaulagu · react本机文档是如何制作的?

7 年前

yearntolearn · R包命名空间

7 年前

Jean-Baptiste Yunès · 如何在XCode中记录Swift函数的参数标签和非参数名称?

7 年前

Dimebag · dict的Python NumPy风格文档

7 年前

m00am · 如何对使用板条箱特性的函数进行doctest?

7 年前

zython Hiery Nomus · Aiohttp errno代码文档?Errno-2/111/113/104/101[关闭]

7 年前

userMod2 · 节点-遍历JS文件的文件夹并提取某些位[关闭]

7 年前

ian · ri中记录的关键字方法参数在哪里?[已关闭]

7 年前