1

我在我的项目中使用 jsdoc3，一切都编译得很好。

但这两天我一直在摆弄，我放弃了:(

当使用来自 MacOsX 终端的最基本调用来运行 jsdoc 时，我总是在生成的文档中获取源文件的完整路径。

例子：

./jsdoc ../projectname/js/jsfile.js

在生成的索引文件中，我可以看到一个带有“索引”的 h1，下面是一个带有 js 文件完整路径的 h2：

/Users/username/projects/path/projectname/js/jsfile.js

我不喜欢它显示我完整的本地路径...
阅读后我认为它与我运行 jsdoc 的位置有关。
但这一切都具有相同的确切结果：

cd /Users/username/projects/path/projectname
../jsdoc-master/jsdoc js/jsfile.js

也

cd /Users/username/projects/path/projectname/js
../../jsdoc-master/jsdoc jsfile.js

问题是，此路径也与行号引用和源代码页面一起使用。而且显示我的内部路径真的不太好...

我想要的输出是projectname/js/jsfile.js或至少只是jsfile.js，但我不能为我的生活得到这个工作。

我希望有人能告诉我我做错了什么。

问候，
扬

4

1 回答 1

0

@Louis 帮助我弄清楚这是 alpha 版本的问题。
3.2.2 没有导出文档的完整路径。

不幸的是，它还有其他问题，比如缺乏对无序列表的支持。
所以我决定坚持使用 3.3.0 并制作一个 shell 脚本来纠正 jsdoc 的错误输出。
外壳文件的内容：

./jsdoc-master/jsdoc ./projectname/js/jsfile.js
ABSPATH=$(cd "$(dirname "$0")"; pwd)
perl -pi -e "s?$ABSPATH/projectname/js/??g" ./out/*.html

所以这基本上从生成的html文件中删除了完整路径。
它有点脏，但它可以工作......

问候，
扬

于 2014-02-28T12:14:45.260 回答