问题如何在Windows上使用JSDoc？

如果这是一个愚蠢的问题，请原谅我，但我完全不知道如何在Windows上使用JSDoc。我知道JSDoc-Toolkit但它有点过时了，谷歌代码库建议改用JSDoc 3。我从Github下载了JSDoc并将jsdoc-master文件夹解压缩到我的本地磁盘上但是找不到任何关于如何使用它来解析我的文件的可靠信息。

4153

2017-11-27 00:35

起源

网站上的文档不是很清楚如何安装它。我感觉到你了。 - Simon Merrick

答案:

您可以下载它作为npm包为了 Node.js JavaScript运行时环境。

安装 Node.js的随附 NPM
打开命令行
键入以下命令安装JsDoc

npm install -g jsdoc
运行JsDoc / generate文档。更多信息

jsdoc path/to/file.js
配置jsdoc （可选的）

2017-11-27 01:14

谢谢，-g选项非常有用！保存必须从.bin文件夹运行它 - OhMyGodThereArePiesEverywhere

即便如此，你也不需要从中运行它 .bin 夹。 npm创建了 node_modules 文件夹并将软件包安装在当前工作目录中，除非 -g 选项通过。因此，如果您不是全局安装它，您应该 cd path/to/project_root 在你跑之前 npm install - Simon Merrick

谢谢，最后一个问题：全局安装时，jsdoc文件夹放在哪里（所以我可以将模板放在那里）？我在D：\ node上安装了node.js，我已经检查了 node_modules 子文件夹（包括在npm中）。 - OhMyGodThereArePiesEverywhere

实际上，我道歉，你是对的。如果您没有全局安装它，您需要 cd 到了 .bin 文件夹或将jsdoc的路径添加到命令的开头 - 我拒绝更具体，因为这是错误的方法。你应该总是安装jsdoc globablly。 - Simon Merrick

我很确定在Windows上它将全局节点模块放在你的用户文件夹中 C:/Users/<you>/node_modules - Simon Merrick

好的，所以我想我想出来了。我不是说这必然是说这是正确的方法，但它对我有用。开始：

1）安装的node.js

2）打开命令提示符

3）作为测试，在根驱动器中创建一个文件夹（c:\test）去吧（cd\test）。我想有一些权限问题，因为我无法在桌面文件夹中使用以下步骤。

4）安装JSDoc包： npm -install jsdoc

5）应该有一个文件夹 test 叫 node_modules

6）去吧 .bin 子文件夹 node_modules

7）应该有一个名为的文件 jsdoc.cmd。使用简单 jsdoc myfile.js 在命令提示符下，在您的文件上执行JSDoc脚本

-1

2017-11-27 01:02

你需要改变第4步 npm install -g jsdoc 你不需要做任何事情 node_modules 夹。 - Simon Merrick

热门问题

不使用eval / new函数的JavaScript模板库当涉及内部类时，Java继承如何工作 .NET Windows服务的奇怪问题在.ipa或.app下查找App ID 快速入门XSLT参考[关闭] 如何找出Android应用程序中未使用的资源 Ruby中并发的同步方法[重复] 将std :: chrono :: system_clock :: time_point转换为struct timeval并返回 Google Drive API V3（javascript）更新文件内容 Bootstrap 3.0 - 将元素推到底部受密码保护的.NET ClickOnce部署？如何用postgresql安装wordpress coq Set或Type如何成为命题硒滚动元素进入（中心）视图在Spring Transaction JUnit测试中自动装配Hibernate会话的正确方法 Git的Dockerfile策略如何在FOS_PICKFOLDER中使用IFileDialog，同时仍在对话框中显示文件名在Firefox扩展中复制Google Chrome浏览器操作弹出效果 CakePHP找到MAX 芹菜 - 完成任务的召唤功能从使用fmemopen创建的流中读取宽字符 .NET是否为每个程序集创建一个字符串实习池？ DefaultModelBinder不绑定嵌套模型 Navigator.MediaDevices.getUserMedia（）使用了哪些相机通信标准？选择命名空间名称时应该知道什么？ cout Swagger Codegen CLI Java客户端 - 如何正确使用它一个很好的哈希函数用于采访整数，字符串？ Maven 3 ciManagement配置的目的是什么？如何通过语言文化获取代码页？

问题 如何在Windows上使用JSDoc？

答案:

热门问题

问题如何在Windows上使用JSDoc？