2013-11-28 9 views
8

jsdocモジュールを使用して、一部のソースコードからドキュメントエントリを抽出したいと考えています。 jsdocモジュールをインストールしました。コマンドラインにjsdocを使用できます。 しかし、私のコードでrequire("jsdoc")とすると、nodejsはCannot find module 'jsdoc'というエラーを投げます。node.jsで実行されているスクリプトでjsdocを使用するには?

私はnodejs v0.8.25とJSDoc 3.3.0-alpha2を持っています。ローカルにもグローバルにもインストールされます。 私はjsdocコマンドを使用することができ、jsdocは私のnode_modulesフォルダにあります。 問題がどこにあるかわかりません。

jsdocについては、コマンドラインインターフェイスでの使用方法やjsソースコードの文書化方法以外のドキュメントがあります。私はいくつかのAPIドキュメントを希望します。

+0

どのようにjsdocをインストールしましたか? 'npm install jsdoc --save'?また、完全なサイドネートとして、ノードを最新の0.10.2xに更新したいと考えているかもしれません。 –

+0

nodejsの最新バージョンに変更して、このコマンドでjsdocをインストールします。私はコマンドラインインターフェイスでそれを使用することができます。私はまだ私のスクリプトでこのモジュールを要求することはできません。 –

+0

'npm install jsdoc --save'の後に' node_modules'ディレクトリに 'jsdoc'ディレクトリがあるかどうかを示すためにあなたの投稿を更新できますか? –

答えて

-3

一般的な自動ドキュメントツールの場合は、YUIDocも使用できます。

の3つの手順の後、あなたは自動的にドキュメントがあります。それをインストールする

  1. を:npm -g install yuidocjs
  2. フォーマットあなたのJSのソースツリーの上にあなたのコンソールで実行yuidoc .YUIDoc Syntax Reference
  3. に関するご意見
+2

質問は特にJSDocについてです。同様に、JSDocとYUIDocは異なるドックレットを使用/必要とします(JSDocは「コード検査」をサポートしています)。 – user2864740

1

正しくjsdocをインストールしていないようです。コマンドラインからnpm install -g jsdocを実行します。これをデフォルトのディレクトリにある新しいターミナルウィンドウ内で実行すると、問題はありません。私は現在の作業ディレクトリからグローバルにノードモジュールをインストールしようとしたが、何らかの理由でモジュールがグローバルにインストールされないという問題があった。

6

私はライブラリとしてjsdocを使用しようとしていましたが、同じ問題が発生しました。 あなたは何も間違っていませんでした。これは、単にライブラリとして使用することを意図したものではありませんでした。

これに関連するjsdocのgithubプロジェクトページにはan issueがあります。 Hegemonic、JSDocのの主な要因は言った:

JSDocのは本当にあなたが問題にnodejsのためのAPIを作成するためにあなたの欲求を表現したい場合がありますライブラリ

として使用するように設計されていませんリンク先

mainフィールドがjsdocのpackage.jsonに宣言されていないため、require('jsdoc')が失敗します。デフォルトでは 'index.js'または 'main.js'に設定されていますが、そのようなファイルもありません。

関連する問題