如何在 Windows 上使用 JSDoc？

Question

如果這是一個愚蠢的問題，請原諒我，但我完全不知道如何在 Windows 上使用 JSDoc。 我知道 JSDoc-Toolkit 但它有點過時了，谷歌代碼庫建議改用 JSDoc 3。 我已經從 Github 下載了 JSDoc，並將 jsdoc-master 文件夾解壓縮到我的本地磁盤上，但找不到任何關於如何使用它來解析我的文件的可靠信息。

Answer 1

您可以將其作為Node.js JavaScript 運行時環境的 npm 包下載。

1. 安裝npm自帶的Node.js
2. 打開你的命令行

3. 輸入以下命令安裝 JsDoc

   npm install -g jsdoc

4. 運行 JsDoc / 生成文檔。 更多信息

   jsdoc path/to/file.js

5. 配置jsdoc （可選）

Answer 2

項目頁面上沒有很好地記錄安裝。

在github-page上解釋得更好。

Answer 3

我不太了解 NodeJS/npm 生態系統。 但是，我執行了以下步驟，它對我有用（在 Windows 上）：

1. 下載NodeJS zip文件並解壓，它用node.exe和npm.cmd創建了一個目錄'node-v16.15.1-win-x64'
2. 執行命令'npm install -g jsdoc'，在'node-v16.15.1-win-x64'下的'node_modules'目錄下，它安裝了jsdoc（在一個文件夾中），並在'node- v16.15.1-win-x64'。
3. 此 jsdoc.cmd 使用完整路徑，但如果沒有安裝完整路徑 jsdoc 並且正在使用上述步驟，但要從任何地方訪問它而不提供完整路徑，我必須設置'node-v16 Windows PATH 上的 .15.1-win-x64' 有效。

我不確定是否回答了 OP 的問題，但 JSDoc 以這種方式為我工作。

Answer 4

我並不是說這一定是最好的方法，但它對我有用：

1. 安裝node.js

2. 打開命令提示符

3. 作為測試，在您的根驅動器 ( c:\\test ) 中創建一個文件夾並轉到它 ( cd\\test )。 我想存在某種權限問題，因為我無法在我的桌面文件夾中執行以下步驟。

4. 安裝 JSDoc 包： npm install jsdoc

5. test應該有一個名為node_modules的文件夾

6. 轉到node_modules的.bin子文件夾

7. 應該有一個名為jsdoc.cmd的文件。 簡單地在命令提示符下使用jsdoc myfile.js來對你的文件執行 JSDoc 腳本