Eclipse中的JavaDoc标记

时间:2016-06-20 12:41:29

标签: java eclipse javadoc

我正在开发一个Java类程序,我们的教授给了我们下面的JavaDoc模板,用于记录每个方法。

/ **      *说明

 * @param
 *   
 * @precondition
 *   
 * @postcondition / return
 *   
 * @exception
 *   
 * @note
 *   
 **/

当我尝试为该程序生成JavaDoc时,我只看到描述,参数和异常。最重要的事情,@ precondition和@postcondition,不会出现。如果我能让@note显示出来也会很好。我尝试在生成JavaDocs时将它们放在额外​​标记选项中手动添加标记,但这不起作用。我正在研究Eclipse Mars 2.0。有没有办法永久地将这些其他标签添加到Eclipse?

1 个答案:

答案 0 :(得分:0)

默认的Javadoc不支持@Precondition,@ Postcondition和@Note。 您可以坚持使用默认值(例如使用@Return而不是@Postresult)。可以找到所有支持的标记here

另一种可能性是创建自己的自定义标签。这可以通过使用-tag <mytagname>:a:<tag text>在Javadoc选项中声明您的标记来完成,可以在docs中找到(只需ctrl-f'-tag')