时间戳

首页 > 解决方案 > 在文档中显示部分方法体

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

问题描述

我想在其文档（JavaDoc）中显示部分方法体。

例如：

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

应该产生如下文件：

    该算法包含步骤：
    makeStep1();
    如果（坐标X == TOP）{
        makeStep2();
    }

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

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

问题：

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

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

标签： javadocumentationjavadocdoxygendoclet

解决方案

在 doxygen 中有两种可能性：

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

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

推荐阅读