JJDoc

自 Apache Ant 1.6 起

描述

调用 JJDoc 预处理器,用于 JavaCC 编译器编译器。它接受一个 JavaCC 解析器规范,并生成 BNF 语法的文档。它可以通过命令行选项以三种模式运行。

要使用 jjdoc 任务,请将 target 属性设置为要处理的 JavaCC 语法文件名称。您还需要使用 javacchome 属性指定包含 JavaCC 安装的目录,以便 Ant 可以找到 JavaCC 类。可选地,您还可以设置 outputfile 将生成的 BNF 文档文件写入到特定的(目录和)文件。否则,jjdoc 将生成的 BNF 文档文件写入到与 JavaCC 语法文件同名,但后缀为 .txt.html 的文件。

此任务仅在语法文件比生成的 BNF 文档文件更新时才调用 JJDoc

参数

属性 描述 必需
target 要处理的 JavaCC 语法文件。
javacchome 包含 JavaCC 发行版的目录。
outputfile 要写入生成的 BNF 文档文件的。如果未设置,则该文件将使用与 JavaCC 语法文件相同的名称,但后缀为 .html.txt
text 设置 TEXT BNF 文档选项。这是一个布尔选项。
onetable 设置 ONE_TABLE BNF 文档选项。这是一个布尔选项。
maxmemory 分配给分叉 JVM 的最大内存量。自 Ant 1.8.3 起

示例

在语法文件 src/Parser.jj 上调用 JJDoc,将生成的 BNF 文档文件 ParserBNF.html 写入 doc

<jjdoc target="src/Parser.jj"
       outputfile="doc/ParserBNF.html"
       javacchome="c:/program files/JavaCC"/>