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

【问题标题】：Using local image assets in dart documentation comments在 dart 文档注释中使用本地图像资源
【发布时间】：2020-09-24 00:19:26
【问题描述】：

如何在 dart 文档注释中使用本地资源？这在使用基于 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/some/local/path.png)
///![](/assets/some/other/path.svg)

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

【问题讨论】：

标签： flutter dart dartdoc

【解决方案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

【讨论】：