- JSDocの設定を確認する: JSDocは、設定ファイル(jsdoc.jsonまたは.jsdocrcなど)を使用して動作します。まず、設定ファイル内の"include"または"exclude"といった関連する設定オプションを確認してください。これらのオプションを使用して、特定のフォルダーやファイルを明示的に指定することができます。必要に応じて、該当するフォルダーを追加または削除してみてください。
例:
{
"include": ["src", "lib"],
"exclude": ["node_modules"]
}
- ファイルの拡張子を確認する: JSDocは、デフォルトでは.jsファイルのみを処理します。もし、JSDocでドキュメント化したいファイルが.js以外の拡張子を持っている場合は、設定ファイル内で"extensions"オプションを使用して拡張子を追加する必要があります。
例:
{
"extensions": [".js", ".jsx"]
}
- コメント形式を確認する: JSDocは、特定のコメント形式を要求します。JSDocがフォルダー内のファイルを認識しない場合、コメントが正しく書かれているか確認してください。以下はJSDocの基本的なコメント形式の例です。
/
* 関数の説明
* @param {型} パラメーター名 - パラメーターの説明
* @returns {型} 戻り値の説明
*/
function 関数名(パラメーター名) {
// 関数の処理
}
- JSDocのバージョンを確認する: JSDocのバージョンが古くなっている場合、特定のフォルダーが認識されない可能性があります。最新バージョンのJSDocを使用しているか確認し、必要に応じてアップグレードしてみてください。