问题标签 [dartdoc]

我想了解是否有办法在由dartdoc.

根据包布局约定，目录中包含一个getting_started.md文件doc/，并显示如下...

该文件如何通过dartdoc以及它在输出中的什么位置合并到文档中？我试图简单地*.md在目录中添加我自己的文件，doc/但它们似乎没有被使用。

我还阅读了 dartdoc文档中的类别，其中指出：

类别：每个类别/主题的更多详细信息。对于您要记录的主题，请使用 markdown: 指定降价文件以用于类别页面。或者，将源代码中的类别重命名为带有“名称：”的显示名称。如果 dartdoc_options.yaml 中没有定义匹配的类别，则源代码中声明的那些类别将不可见。

所以我然后尝试dartdoc_options.yaml像这样引用文件中的其他文档...

但这也没有产生任何结果。

有谁知道是否可以包含其他文档，如果可以，如何实现？

我无法使用dartdoc位于C:\flutter\bin\cache\dart-sdk\bin. 这就是我所做的：

1. 转到项目目录dir C:\Users\alber\Documents\progetto_fomet\fomet_app\lib

2. 调用命令dartdoc

它之所以有效，是因为C:\Users\alber\Documents\progetto_fomet\fomet_app\lib\doc\api我看到了文档，但它不包括我的代码文档！

该工具生成 dart 的文档，如下所示

但它不会在颤动中生成我的应用程序的文档

在红色中，您会看到我的应用程序的源代码不是在 doc\api 中生成的。该怎么办？

我在 Windows 10 上

我正在尝试使用dartdoc为 Flutter App 生成文档。为此，我进入 Flutter App 文件夹：

之后我在控制台中调用：

控制台中打印的第一个结果告诉我 dartdoc 正在解析我的应用程序的文件，但随后正在尝试解析 Flutter 源文件（如/opt/Flutter/bin...）。有没有办法只解析我的应用程序的文件夹？

我正在尝试为我的颤振包运行 dartdoc，但我得到了这个，

如何添加 FLUTTER_ROOT 环境变量，因为我已经为 Flutter SDK 添加了环境变量并且工作正常，我只是在运行时遇到问题dartdoc。我是 Linux 用户。

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

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

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

我的配置：

• 我的 Flutter 顶级bin文件夹位于C:\src\flutter\flutter.
• 我的FLUTTER_ROOT环境变量具有C:\src\flutter\flutter我的用户和系统的值。

如果我在 Powershell 或命令提示符下使用权限运行它，它会解析每个 dart 核心库（dart-async、dart-collection、dart-core等）和每个 Flutter 核心库，我认为生成我的库的文档是可以理解的，但它也会为所有人生成文档那些飞镖核心库。这是预期的行为吗？

我将 Flutter 包发布到https://pub.dev/并找到此消息（如屏幕截图所示）。我该怎么做才能解决这个问题？

这应该与 相关dartdoc，但我不确定我必须添加多少信息。
我还认为很难进行小的更改并多次发布以进行测试，因为我每次都必须更新版本和更改日志。

如何在 dart 文档注释中使用本地资源？这在使用基于 Web 的 url 时效果很好，如下所示：

我想做的是引用我的资产文件夹中的一些图像资产并显示它们。像这样的东西：

但是我无法获得任何相对的工作路径，这可能吗？

我在 Flutter 存储库中看到了如下片段：

在 IDE 和渲染的 Dart 文档中，它显示如下：

是否可以更改文本。

当此设置为 true 时，文本不能通过任何快捷方式或键盘操作进行修改。文本仍然是可选的。

默认为假。不得为空。

它往往超出这个基本情况。

这是我想要完成的一个例子。

所以method2的文档将是：

这是此方法的文档字符串。
方法 2 文档字符串添加到方法 1 的此处。

我很确定我以前见过这样做。无需在适用的情况下重写文档。还可以更轻松地维护准确的文档。

dart 中这个的正确语法是什么？

这是一个项目的一部分，我正在为教育目的构建 Flickr 应用程序的克隆。

我第一次玩 Dartdoc 和文档概念，我设法使用 Dartdoc 并为我的项目创建了一个包含文档的 Doc 文件夹。但是，对于我所有的有状态小部件，小部件本身已经正确记录了但是状态对象（我有我的构建方法、我的 initstate 方法和我的状态变量的对象），我没有得到任何文档，是默认行为还是我做错了什么？我想为这个状态对象、它里面的方法和里面的变量生成文档。

除此之外，我收到了一些警告，我将进一步研究这些警告，如果无法解决它们，我将打开一个单独的问题。

这是我使用 Dartdoc 的方式：

Dartdoc 命令

Dartdoc 命令结束

生成的文档

生成的文档_方法

如果我的问题很愚蠢，请原谅我，这是我第一次使用文档：D

编辑：我正在做的一个天真的解决方案是，我将大部分变量和方法移动到小部件对象而不是状态对象。这是解决这个问题的正确方法吗？