有没有办法在javadocs中包含正文注释?

时间:2009-10-23 18:16:37

标签: documentation comments javadoc

我们有一个庞大的Java代码库(混合了一些Groovy),基本上没有为它编写javadoc。

然而,大部分代码在分散在全身的“老派”评论中都有相当详细的记录。

我们现在正努力尝试将事情记录得更好 - 例如,Javadocs现在正在定期生成。作为一种权宜之计,如果javadoc会“掠夺”类的主体(或函数,或其他任何内容)并将所有注释放入“存根”javadoc中,那将是非常好的。

有办法吗?

1 个答案:

答案 0 :(得分:2)

听起来好主意,因为javadoc通常描述元素的用途和用法,而代码正文评论是(或应该)有关实现的细节。

但如果必须,你显然需要编写自己的自定义doclet,它与java源文件解析器(第三方或您自己的)一起工作。对于每个已处理的类,您将首先在该给定java类的源文件上运行解析器并获取内部注释,然后扩充(标准)doclet生成的(标准)html以添加代码注释。

一种可能有助于使结果javadoc变得合理的策略是包含给定方法对该方法的javadoc的内部注释。只需使用'pre'闭包,并在通用javadoc html的末尾追加方法的解析注释。