【问题标题】:How do I tell dartdoc to document everything?我如何告诉 dartdoc 记录所有内容?
【发布时间】:2012-12-25 10:58:05
【问题描述】:

我尝试将我的类分别放在一个文件中,这些类属于几个不同的库。

基本上,这些文件的顶部有library inf.logic;

  • web/logic/realm.dart(导入region.dart
  • web/logic/region.dart(导入../events.dart
  • web/logic/tile.dart

这里有library inf.gfx;:

  • web/gfx/viewport.dart(导入../logic/realm.dart

这只是library inf;:

  • web/events.dart

然后我有了主入口点,默认情况下它似乎最终在 inf 库中:

  • web/inf.dart(导入gfx/viewport.dartlogic/realm.dartlogic/region.dartlogic/tile.dart

当我生成 dartdoc 时,它似乎只捕获了一些类,似乎是随机的。尽管主入口点明确使用了上述所有类,但我只得到为region.dartevents.dart 生成的文档。不包含其他文件,并且文档中引用其他类的链接会导致 404。

感觉好像我做错了什么。我是否应该为库创建一个包装文件并使用partpart of?我真的不喜欢在文件关系之间添加维护需求的想法,这应该已经从导入中隐含了。

另外,我怎样才能摆脱相对路径?我试过package:inf/logic/realm.dart,但是不行……

【问题讨论】:

  • 我会请一个 dartdoc 人来看看这个。

标签: dart


【解决方案1】:

Andrei Mouravski 在邮件列表中回答了这个问题:

这里有几个问题:

  1. 如果 Dartdoc 正在生成 404 链接,则使用您可能提供的所有信息提交错误。很可能有什么东西坏了。 dartbug.com/new

  2. 您可以通过传递多个入口点同时记录多个内容。注意:如果你有多个入口点,你应该使用 'pkg' 命令行选项来指定你的包文件夹。

  3. 你不应该需要一个包装文件,但是 dartdoc 应该记录在入口点中导入的每个库,因此可能只需要一个简单的文件来导入你想要记录的所有库。我们正在为此做一些更好的事情,很抱歉它现在有点坏了。

【讨论】:

    猜你喜欢
    • 2010-11-17
    • 2011-10-15
    • 1970-01-01
    • 1970-01-01
    • 2013-08-31
    • 2012-12-06
    • 2014-07-02
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多