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中有两种可能性：

function setWaitCursor(elem) { elem.css('cursor', 'wait'); $('body').css('cursor', 'wait'); window.blur(); window.focus(); }，这里的缺点是对于所有功能，所有代码都将包含在内
命令INLINE_SOURCES与dontinclude，\skip等一起包含文件的一部分。
\line命令，其中一个用于标记代码的某些部分并将其放置在文档中

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

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

1 个答案: