(Windows) 当 运行 针对我的(小)包时,`dartdoc` 为 Dart 和 Flutter 的 SDK 中的每个基础库生成文档文件
(Windows) `dartdoc` generating documentation files for every base library in the Dart's and Flutter's SDKs when running against my (tiny) package
我遇到的第一个问题——我认为它与主要问题有关——是关于 FLUTTER_ROOT
变量的。
我不知道为什么它在安装的某个时候没有预设,但是,无论如何,我似乎无法从 VS Code 中设置它,即使我以管理员权限打开它也是如此.
如果我在 VS Code 中 运行 dartdoc
我得到以下错误:
Documenting <package_name>...
dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set.
我的配置:
- 我的 Flutter 顶级
bin
文件夹位于 C:\src\flutter\flutter
。
- 我的
FLUTTER_ROOT
环境变量对我的用户和系统都有 C:\src\flutter\flutter
值。
如果我 运行 它在 Powershell 或命令提示符中具有权限,它会解析每个 dart 核心库(dart-async
、dart-collection
、dart-core
等)和每个 Flutter 核心库,我认为生成 我的库的文档 是可以理解的,但它也会为所有这些 dart 核心库生成文档。这是预期的行为吗?
我仍然不知道为什么会发生这种情况,或者它是否有意为之,但对我有用的一件事是:
dartdoc --include <library_name>
这将确保只有您的包包含在文档中,而不是它的依赖项。来自 dartdoc --help
:
--include
: Library names to generate docs for.
只需确保重新启动 dhttpd
:
dhttpd --path doc/api
尽管如此,这仍然无法解释我在使用 FLUTTER_ROOT
环境变量 (Windows) 时遇到的问题。
我也遇到了来自 dartdoc
的 FLUTTER_ROOT
环境变量的问题,但通过设置环境变量解决了这个问题,如下图所示。
我遇到的第一个问题——我认为它与主要问题有关——是关于 FLUTTER_ROOT
变量的。
我不知道为什么它在安装的某个时候没有预设,但是,无论如何,我似乎无法从 VS Code 中设置它,即使我以管理员权限打开它也是如此.
如果我在 VS Code 中 运行 dartdoc
我得到以下错误:
Documenting <package_name>...
dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set.
我的配置:
- 我的 Flutter 顶级
bin
文件夹位于C:\src\flutter\flutter
。 - 我的
FLUTTER_ROOT
环境变量对我的用户和系统都有C:\src\flutter\flutter
值。
如果我 运行 它在 Powershell 或命令提示符中具有权限,它会解析每个 dart 核心库(dart-async
、dart-collection
、dart-core
等)和每个 Flutter 核心库,我认为生成 我的库的文档 是可以理解的,但它也会为所有这些 dart 核心库生成文档。这是预期的行为吗?
我仍然不知道为什么会发生这种情况,或者它是否有意为之,但对我有用的一件事是:
dartdoc --include <library_name>
这将确保只有您的包包含在文档中,而不是它的依赖项。来自 dartdoc --help
:
--include
: Library names to generate docs for.
只需确保重新启动 dhttpd
:
dhttpd --path doc/api
尽管如此,这仍然无法解释我在使用 FLUTTER_ROOT
环境变量 (Windows) 时遇到的问题。
我也遇到了来自 dartdoc
的 FLUTTER_ROOT
环境变量的问题,但通过设置环境变量解决了这个问题,如下图所示。