jsdoc问题:显示源文件的完整路径(不需要)

时间:2014-02-27 18:12:09

标签: javascript macos terminal jsdoc jsdoc3

我正在为我的项目使用jsdoc3,所有内容编译得很好。

但过去两天我一直在摆弄,我放弃了:(

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

示例:

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

在生成的索引文件中,我可以看到带有“index”的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,但我不能为我的生活让它发挥作用。

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

的问候,

1 个答案:

答案 0 :(得分:0)

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

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

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

所以这基本上删除了生成的html文件的完整路径 它有点脏,但它有效...

的问候,