5

我是 asciidoc 的新手。我想从 java 文件中的注释 javadoc（asciidoc 格式）生成 HTML 文档。

例如java文件

/**
 * = Asciidoclet
 *
 * Sample comments that include `source code`.
 *
 * [source,java]
 * --
 * public class Asciidoclet extends Doclet {
 *     private final Asciidoctor asciidoctor = Asciidoctor.Factory.create();
 *
 *     @SuppressWarnings("UnusedDeclaration")
 *     public static boolean start(RootDoc rootDoc) {
 *         new Asciidoclet().render(rootDoc);
 *         return Standard.start(rootDoc);
 *     }
 * }
 * --
 *
 * @author https://github.com/johncarl81[John Ericksen]
 */
public class Asciidoclet extends Doclet {
}

我可以从 .ad 文件生成 html 文件，但我不知道如何从 javadoc 生成 .ad（或任何 asciidoc 格式文件）。
所以我想生成 .ad（asciidoc 文件），我用它来使用 asciidoctor-maven-plugin 生成 html 文档。asciidoctor-maven-plugin 将检查 sourceDirectory 中的 .ad 文件并在 outputDirectory 中生成 html 文件。

</plugin>
<plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>${asciidoctor.version}</version>
    <executions>
        <execution>
            <id>output-html</id>
            <phase>generate-resources</phase>
            <goals>
                <goal>process-asciidoc</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <sourceDirectory>asciidocs</sourceDirectory>
        <outputDirectory>asciidocs-output</outputDirectory>
        <backend>html</backend>
        <doctype>book</doctype>
    </configuration>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <configuration>
        <source>1.7</source>
        <doclet>org.asciidoctor.Asciidoclet</doclet>
        <docletArtifact>
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoclet</artifactId>
            <version>${asciidoclet.version}</version>
        </docletArtifact>
        <overview>src/main/java/overview.adoc</overview>
        <additionalparam>
            --base-dir ${project.basedir}
            --attribute "name=${project.name}"
            --attribute "version=${project.version}"
            --attribute "title-link=http://example.com[${project.name} ${project.version}]"
        </additionalparam>
    </configuration>
</plugin>

依赖

<asciidoclet.version>1.5.0</asciidoclet.version>
<asciidoctor.version>1.5.0</asciidoctor.version>

<dependency>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctorj</artifactId>
    <version>1.5.2</version>
</dependency>

我引用了 asciidoclet，但我无法获得任何有用的信息。所有示例项目也用于生成 html、pdf、epub 等。
谢谢...

更新
我更改了我的 maven-javadoc-plugin 配置如下并执行mvn org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar，但它生成正常的 html java 文档，它应该生成 .adoc 文件。谁能帮助我我做错了什么？
谢谢...

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>javadoc-jar</id>
            <phase>package</phase>
            <goals>
                <goal>jar</goal>
            </goals>
            <configuration>
                <includeDependencySources>true</includeDependencySources>
                <dependencySourceExcludes>
                    <dependencySourceExclude>commons-cli:*</dependencySourceExclude>
                </dependencySourceExcludes>
                <source>1.7</source>
                <doclet>org.asciidoctor.Asciidoclet</doclet>
                <docletArtifact>
                    <groupId>org.asciidoctor</groupId>
                    <artifactId>asciidoclet</artifactId>
                    <version>${asciidoclet.version}</version>
                </docletArtifact>
                <overview>src/main/java/overview.adoc</overview>
                <additionalparam>
                    --base-dir ${project.basedir}
                    --attribute "name=${project.name}"
                    --attribute "version=${project.version}"
                    --attribute "title-link=http://example.com[${project.name} ${project.version}]"
                </additionalparam>
            </configuration>
        </execution>
    </executions>
</plugin>

我正在使用以下依赖项。

4

1 回答 1

2

看起来你对 Asciidoclet 正在做什么的想法有点不对劲。它不是为创建 Asciidoc 而设计的，而是设计为能够在 Asciidoc 中编写 javadoc，然后将其转换为 javadoc 命令的 html 输出。

您可能想要研究的是为 asciidoctor 构建一个自定义包含模块，该模块将获取您的 asciidoc javadoc 源，去除 java 注释并将其包含到您正在创建的其他输出中。

于 2015-01-28T18:43:41.327 回答