jsdoc问题:显示源文件的完整路径(无意)



我的项目使用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,但我一辈子都无法实现。

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

问候,
一月

@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文件中删除完整路径
它有点脏,但它有效。。。

问候,
一月

最新更新