-
npmを使用してJSDocをインストールする方法: JSDocはnpmパッケージとして提供されているため、npmを使用してインストールできます。以下のコマンドを実行してインストールします。
npm install -g jsdoc
上記のコマンドは、グローバルにJSDocをインストールします。もしプロジェクトごとにインストールする場合は、プロジェクトディレクトリ内で上記のコマンドを実行します。
-
JSDocの基本的な使い方: JSDocを使用するためには、コード内にドキュメンテーションコメントを追加する必要があります。以下はJSDocの基本的な使い方の例です。
/ * 関数の説明 * @param {string} name - 名前 * @param {number} age - 年齢 * @returns {string} - メッセージ */ function greet(name, age) { return `こんにちは、${name}さん!${age}歳ですね。`; }
上記の例では、関数
greet
の引数と戻り値の型、および関数自体の説明をJSDocコメントで指定しています。 -
JSDocのドキュメント生成: JSDocを使用すると、コードからドキュメントを生成できます。以下のコマンドを実行して、JSDocでドキュメントを生成します。
jsdoc ファイル名.js
上記のコマンドを実行すると、JSDocに基づいたHTML形式のドキュメントが生成されます。
以上がJSDocの基本的なインストールと使用方法です。これにより、コードのドキュメンテーションを効果的に行うことができます。