【问题标题】:How to use dartdoc to generate the documentation for flutter like docs.flutter.io?如何使用 dartdoc 生成类似 docs.flutter.io 的 Flutter 文档?
【发布时间】:2018-05-12 09:18:47
【问题描述】:

我找到了 dartdoc 的命令,当我运行它时,我得到了 Dart 的 api 文档。如何像 docs.flutter.io 一样为 Flutter 生成文档?

【问题讨论】:

    标签: dart flutter


    【解决方案1】:

    运行

    pub global activate dartdoc
    dartdoc
    

    另见https://pub.dartlang.org/packages/dartdoc

    默认情况下,文档仅针对lib/ 中的公共 API 生成。 lib/src/ 中的代码如果没有从 lib/ 中的文件导出,则被视为私有代码

    【讨论】:

    • @Creatint 很高兴听到。如果这解决了您的问题,请考虑接受答案以使用向上/向下投票按钮下方的复选标记将其标记为已回答。谢谢。
    • dartdoc 尝试解析所有颤振源以及我的项目文件。这正常吗?
    • 'pub' 不是内部或外部命令、可运行程序或批处理文件。
    • @SathishGadde 抱歉,我错过了这是 Flutter 特有的。如果您没有安装 Dart SDK,请改用 flutter pub global activate dartoc。它只是通过一些额外的设置转发到pub
    • 文档生成成功。但是,小部件内部的方法不可见。只有静态常量变量 cmets 在文档输出中可见。最终文档中没有可见的用户定义方法。
    猜你喜欢
    • 1970-01-01
    • 2012-04-06
    • 2014-08-24
    • 2011-10-11
    • 2019-10-18
    • 1970-01-01
    • 1970-01-01
    • 2022-12-19
    • 1970-01-01
    相关资源
    最近更新 更多