Exemplify - 为作者提取示例代码的工具

目的

我发现，如果示例代码是可编译代码库的一部分，那么保持示例代码绿色和活跃更容易。此工具允许您注释源代码的各个部分，并生成可包含的示例文件，突出显示部分。

用法

首先，在源文件中注释示例。您可以组合多个块，它们将根据可选的 part 参数按顺序显示。

// This chunk will be indented by 4 spaces relative to the other chunks in this example
//##exemplify-start##{name="name of the example" part=1 indentation=4 title="Some title" language="typescript"}
export class Foobar {
    doSomething() {} // ##exemplify-callout##{value="Some callout"}
}
//##exemplify-end##

function doNotShowThis() {
    // This will not be part of the example output file
}

//##exemplify-start##{name="name of the example" part=2}
new Foobar();
//##exemplify-end##

exemplify -s /path/to/example/code/root -o /path/to/output/folder -e "ts" --output-format=asciidoc

这应在您的输出文件夹中创建名为 name of the example.adoc 的文件，内容如下

.Some title
[source,typescript]
----
    export class Foobar {
        doSomething() {} <1> Some callout
    }
new Foobar();
----
<1> Some callout