在文档中显示方法主体的一部分

Question

我想在其文档(JavaDoc(中显示方法主体的一部分。

例如：

/**
 * The algorithm contains steps:
 * @showMethodBody
 */
public void algorithmX(int coordinateX) {
    makeStep1();
    if (coordinateX == TOP) {
        makeStep2();
    }
}

这应该产生这样的文档：

    该算法包含以下步骤：    makeStep1((;    if (coordinateX == TOP( {        makeStep2((;    }

我知道这样的文档有点愚蠢，而且不是自然语言。但最好的事情是它永远不会过时。

因此，一般概念可以用自然语言描述，但关键元素可以直接从源代码中复制。如您所见，源代码对于不是程序员来说也可能是有用的。这是我的问题：

问题：

如何在方法的文档内复制(显示(部分或整个方法主体？

现在我正在使用JavaDoc，但我也可以使用任何其他工具。如果有帮助，我还可以在源代码中添加一些指针(注释或特殊注释(。

Answer 1

在doxygen中，有几种可能性：

• INLINE_SOURCES，这里的缺点是所有函数都将包含所有代码
• 命令dontinclude，连同skip、line等来包含文件的各个部分。
• snippet命令，在其中标记代码的某些部分并可以将它们放置在文档中

另请参阅doxygen手册，http://www.doxygen.nl/manual/在这种情况下，"特殊命令"和"配置"章节