【问题标题】:Haxe documentation XML: how to exclude standard library?Haxe 文档 XML:如何排除标准库?
【发布时间】:2014-07-06 04:21:51
【问题描述】:

我想在 Haxe 中制作一个小工具,用于检查 haxedoc cmets。我认为获取这些 cmets 的最佳方法是使用“haxe -xml”选项,然后加载生成的 XML 文件。

但是,当我生成 XML 时,它似乎在输出 XML 中包含了整个标准库。当我将此 XML 传递给 Dox 时,它会为我的代码生成文档标准库的东西,例如类、日期、字符串、枚举...

这是预期的行为吗?有没有办法从生成的 XML 中排除标准库条目?或者我应该编写我的工具来根据包/文件名/等过滤 XML?

这是我的构建脚本:

/build.hxml

-cp src
-neko main.n
--no-output
-xml bin/xml/neko.xml
--macro "include('doctest')"

这是我要为其生成 XML 的文件:

/src/doctest/Main.hx

package doctest;

//import neko.Lib;

/**
 * ...
 * @author jjokin
 */
class Main 
{
    static function main() 
    {
    }
}

/**
 * This class does some stuff.
 */
class DemoClass {
}

【问题讨论】:

    标签: xml documentation haxe documentation-generation rtti


    【解决方案1】:

    好的,我想我已经解决了。编译后的 XML 必须始终包含所有内容——例如 Array、Enum、Class、List——因为编译成其他语言需要这些内容。我看过 Dox,它有“-in/--include”和“-ex/--exclude”选项,可以让您过滤元素以生成文档。所以,我的模块需要做类似的事情。

    【讨论】:

    • 您也可以调用Compiler.exclude("String") 等来排除它们的生成。我还没有测试这是否适用于 Xml 文档,但它可能值得一试。过滤完整列表是大多数图书馆似乎都在做的事情。见api.haxe.org/haxe/macro/Compiler.html#exclude
    • 对于将来返回这里的任何人,使用 haxelib run dox -in "^your\.package\.regex" … 可以正常工作 - 仅包括您的类,而不包括标准库。不需要-ex
    猜你喜欢
    • 2015-01-05
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2012-09-18
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多