在飞镖文档注释中使用本地图像资源

Question

如何在飞镖文档注释中使用本地资产？当使用基于 Web 的 url 时，这工作正常，如下所示：

/// ![A row of icons representing a pink heart, a green musical note, and a blue umbrella](https://flutter.github.io/assets-for-api-docs/assets/widgets/icon.png)

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

///![](/assets/some/local/path.png)
///![](/assets/some/other/path.svg)

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

Answer 1

这并不完全令人满意，但我只是制作了一个 shell 脚本，将作为文档一部分的图像复制到生成的 HTML 树中的正确位置，即：

#!/bin/sh -x
cd `dirname $0`
dartdoc
cd lib
for f in `find . -name '*.comments' -print` ; do
dir=`basename $f .comments`
cp -r $f ../doc/api/$dir
done
cd ..

ObRant：令我失望的是，文档生成工具通常不会这样做(至少是AFAIK(。 可视化传达可以大大改善文档！

例如，考虑一下Java的这一部分。 UML对理解结构有很大帮助。 http://spritely.jovial.com/javadocs/index.html?edu/calpoly/spritely/package-summary.html