javascript - jsdoc问题: Full path to source file is displayed (unwantedly)

标签 javascript macos terminal jsdoc jsdoc3

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

但这两天我一直在摆弄,最后我放弃了:(

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

示例:

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

在生成的索引文件中,我可以看到带有“index”的 h1 和其下方的 h2,其中包含 js 文件的完整路径:

/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 的错误输出。
shell文件的内容:

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

所以这基本上删除了生成的 html 文件的完整路径。
虽然有点脏,但是很管用……

问候,
一月

关于javascript - jsdoc问题: Full path to source file is displayed (unwantedly),我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/22076862/

相关文章:

javascript - 使用 Firebase 时如何保护客户端源

javascript - AWS Lambda [Node.js 4.3] - 奇怪的堆栈跟踪

java - 如何在 Java 1.8 中使用 com.apple?

php - 在 linux/freebsd/macosx 上使用 PHP 查找实用程序的安装路径

terminal - 使用 bash_profile 自定义终端命令

javascript - 在 CKEDITOR 4.0 中复制和粘贴自定义标签

javascript - 如何在 jQuery 中单击后禁用按钮

macos - cocoa MVC:“模型 Controller ”和“ View Controller ”之间的交互

terminal - Xcode 6 - 如何从终端在 IOS Simulator Mobile Safari 中打开 Url?

推送时Git错误400