我正在尝试为我的颤振包运行 dartdoc,但我得到了这个,
dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set.
Run Code Online (Sandbox Code Playgroud)
如何添加 FLUTTER_ROOT 环境变量,因为我已经为 Flutter SDK 添加了环境变量并且工作正常,我只是在运行时遇到问题dartdoc。我是 Linux 用户。
我想了解是否有办法在由dartdoc.
根据包布局约定getting_started.md,doc/目录中包含一个文件,显示如下...
enchilada/
...
doc/
api/ ***
getting_started.md
Run Code Online (Sandbox Code Playgroud)
该文件如何合并到文档中dartdoc以及它在输出中的何处显示?我试图简单地*.md在doc/目录中添加我自己的文件,但它们似乎没有被使用。
类别:为每个类别/题目的更多细节。对于您想要记录的主题,使用 markdown: 指定 markdown 文件以用于类别页面。或者,将源代码中的类别重命名为带有“name:”的显示名称。如果 dartdoc_options.yaml 中没有定义匹配的类别,则源代码中声明的类别将不可见。
所以我然后尝试dartdoc_options.yaml像这样引用文件中的其他文档......
dartdoc:
categories:
"Getting Started":
markdown: doc/getting_started.md
"Search Filters":
markdown: doc/search_filters.md
categoryOrder: ["Getting Started", "Search Filters"]
Run Code Online (Sandbox Code Playgroud)
但这也没有产生任何结果。
有谁知道是否可以包含其他文档以及如何完成此操作?
我在整个 Flutter 仓库中看到过如下片段:
/// {@macro flutter.widgets.editableText.readOnly}
Run Code Online (Sandbox Code Playgroud)
在 IDE 和渲染的 Dart 文档中,它显示如下:
文本是否可以更改。
当此设置为 true 时,文本无法通过任何快捷方式或键盘操作进行修改。文本仍然可以选择。
默认为假。不能为空。
它往往远远超出这个基本情况。
如何在 dart 文档注释中使用本地资源?当使用基于网络的 url 时,这可以正常工作,如下所示:
/// 
Run Code Online (Sandbox Code Playgroud)
我想做的是引用我的资产文件夹中的一些图像资产并显示它。像这样的东西:
///
///
Run Code Online (Sandbox Code Playgroud)
但我无法获得任何相对的工作路径,这可能吗?
是否可以在不同文件中的另一个函数的文档中显示一个函数的文档?宏仅在其自己的文件中有效。
在Flutter源码中,他们使用了这样的东西,但似乎没有任何效果:
/// {@macro flutter.widgets.editableText.keyboardType}
Run Code Online (Sandbox Code Playgroud)