如何在node.js上運行的腳本中使用jsdoc？

我想用jsdoc模塊從一些源代碼中提取文檔條目。我已經安裝了jsdoc模塊，我可以在命令行中使用jsdoc。但是，當我在我的代碼中require("jsdoc")，nodejs拋出一個錯誤，說Cannot find module 'jsdoc'。如何在node.js上運行的腳本中使用jsdoc？

我有nodejs v0.8.25和JSDoc 3.3.0-alpha2。它在本地和全球安裝。我可以使用jsdoc命令，我在node_modules文件夾中有jsdoc。我看不出問題在哪裏。

在哪裏可以找到一些關於jsdoc的文檔，而不是如何在命令行界面中使用它或如何記錄js源代碼。我想要一些API文檔。

來源

2013-11-28 Richard Dong

你是怎麼安裝jsdoc的？ 'npm install jsdoc --save'？另外，作爲一個完整的旁註，您可能想要將節點更新到最新的0.10.2x –

我更改爲最新版本的nodejs，並使用該命令安裝jsdoc。我可以在命令行界面中使用它。我仍然不能在我的腳本中需要這個模塊。 –

你能否更新你的帖子，以表明在'npm install jsdoc --save'之後是否在'node_modules'目錄中有'jsdoc'目錄？ –

-3

如果是一般的自動文檔工具，也可以使用YUIDoc。

按照這三個步驟，你將有你的自動文檔：

安裝它：關於YUIDoc Syntax Reference
在控制檯運行yuidoc .你的JS源代碼樹的頂部npm -g install yuidocjs
格式您的意見

來源

2013-11-28 07:51:24

這個問題具體是關於JSDoc的。而類似的，JSDoc和YUIDoc使用/需要不同的doclet（JSDoc支持「代碼檢查」）。 – user2864740

這聽起來像你沒有正確安裝jsdoc。從命令行運行npm install -g jsdoc。如果您在默認目錄中的新終端窗口中運行此應用程序，則不應該有任何問題。我遇到了一些問題，我試圖從當前的工作目錄中全局安裝一個節點模塊，並且出於某種原因模塊不能全局安裝。

來源

2013-11-28 08:21:51 leaksterrr

我正在尋找使用jsdoc作爲庫，我偶然發現了同樣的問題。你沒有做錯任何事，它從來沒有打算被用作圖書館。

在jsdoc的github項目頁面上有an issue與此相關。 Hegemonic，JSDoc的主要貢獻者說：

JSDoc是不是真的設計用來作爲一個庫

你可能想表達自己的願望，對於在這個問題上的NodeJS創建API上面鏈接。

require('jsdoc')失敗，因爲在jsdoc的package.json中沒有聲明main字段。它可能默認爲'index.js'或'main.js'，但是也沒有這樣的文件。

來源

2013-12-11 15:32:26

如何在node.js上運行的腳本中使用jsdoc？

回答

相關問題