2012-07-06 24 views
2

我参与了一个项目,并且有人正在推出一系列好东西,但是它的英文和日文都是javadoc。他在这样做,例如,法评论:如何才能最好地创建多语言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> 
    */ 

有JS投入生成的Javadoc的报头的片段,它工作得很好。它会检测您的浏览器的语言,并只显示正确的评论。

那么,我该如何摆脱这些该死的消息时产生的javadoc:

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

有没有我们可以做这一点,更洁净的方法吗?任何其他的方法,将工作以及?

感谢名单 - 射线

回答

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> 
*/ 
+0

哦。我的。神。 :-)我能说什么。是的。这非常好。或者我只是那么愚蠢。 :-) – 2012-07-15 05:50:02

0

以前的答案是不行的,但回答者可能不知道。问题是我们大多数人使用eclipse,而人们喜欢通过在方法,字段或类上进行鼠标悬停而看到的javadoc。如果有人这样做的话,人们可以让javadoc在网页中显示时显示正确的东西。但是,当在另一个应用程序中显示页面的片段时,无法应用CSS来获得所需的结果。

我在想我会做的是创建一个预处理源的doclet。它将挑选出没有语言标签或正确语言标签的元素,并创建特定于该语言的源的副本。然后javadoc世代可以正常进行。

要么是这个,要么这个doclet会生成javadoc本身而不会产生中间源。我们会看到。