[英]Using local image assets in dart documentation comments
如何在 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)
但是我無法獲得任何相對的工作路徑,這可能嗎?
這並不完全令人滿意,但我剛剛制作了一個 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
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.