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

Question

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

例如:

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

应该生成如下文档:

    The algorithm contains steps:    makeStep1();    if (coordinateX == TOP) {        makeStep2();    }

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

因此，一般概念可以用自然语言描述，但关键元素可以直接从源代码复制。正如您所看到的，源代码也可以为非程序员提供信息。这是我的问题:

问题:

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

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

Answer 1

在 doxygen 中有几种可能性:

• INLINE_SOURCES，这里的缺点是对于所有函数，所有代码都将包含在内
• 命令 dontinclude 与 \skip、\line 等一起包含文件的某些部分。
• \snippet 命令，用于标记代码的某些部分并可以将它们放入文档中

另请参阅 doxygen 手册:http://www.doxygen.nl/manual/在本例中为“特殊命令”和“配置”章节