windows - (Windows) `dartdoc` 在运行我的（小）包时为 Dart 和 Flutter 的 SDK 中的每个基础库生成文档文件

Question

我遇到的第一个问题——我认为与主要问题有关——与FLUTTER_ROOT变量有关。

我不知道为什么它在安装的某个时候没有预设，但是，无论如何，我似乎无法从 VS Code 中设置它，即使我以管理员权限打开它也是如此。

如果我dartdoc在 VS Code 中运行，我会收到以下错误：

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 核心库，我认为生成我的库的文档是可以理解的，但它也会为所有人生成文档那些飞镖核心库。这是预期的行为吗？

标签： windowsflutterdartdocumentationdartdoc

Answer 1

我仍然不知道为什么会发生这种情况或是否有意，但对我有用的一件事是：

dartdoc --include <library_name>

这将确保只有您的包包含在文档中，而不是它的依赖项。来自dartdoc --help：

--include：要为其生成文档的库名称。

只要确保重新启动dhttpd：

dhttpd --path doc/api

尽管如此，这一切仍然不能解释我在FLUTTER_ROOT环境变量（Windows）方面遇到的麻烦。