如何最好地创建多语言javadoc?

时间:2012-07-06 04:56:16

标签: javadoc multilingual

我参与了一个项目,有人正在投入一大堆好东西,但是英语和日语都有javadoc。他正在这样做,例如,方法评论:

    /**
     * Return really great stuff.
     *
     * <span class="en">By the way, here are some details.</span>
     * <span class="ja">Here are the details in katakana...</span>
     */

在生成的javadoc的标题中放入了一段js,它运行得很好。它会感知您的浏览器的语言,只显示正确的评论。

那么,在生成javadoc时如何摆脱这些愚蠢的消息:

    OurUtils.java:139: warning - Parameter "delivery" is documented more than once.

我们有没有办法做更多犹太教徒?还有其他任何方法吗?

thanx - ray

2 个答案:

答案 0 :(得分:1)

请勿两次提及@parameter delivery

/**
 * @param delivery
 * <span class="en">By the way, here are some details.</span>
 * <span class="ja">Here are the details in katakana...</span>
 */

答案 1 :(得分:0)

之前的回答不起作用,但回答者无法知道。问题是我们大多数人都使用eclipse,人们喜欢在方法,字段或类上执行鼠标操作时看到的javadoc。如果有人在上面做了这个技巧,那么当一个人在网页中显示它时,可以让javadoc显示正确的东西。但是当一个人在另一个应用程序中显示一个页面片段时,就无法应用CSS来获得所需的结果。

我想我要做的是创建一个预处理源的doclet。它将挑选出没有语言标签或正确语言标签的元素,并创建仅针对该语言的源副本。然后javadoc生成可以正常进行。

或者,或者这个doclet将生成javadoc本身而不生成中间源。我们会看到。