コンフィグファイル
パッケージファイル
READMEファイル
テンプレート
チュートリアルファイル

コンフィグファイル

メモ

  • 各種設定をコンフィグファイルに記述
    • 起動オプション (-c・--configure)コンフィグファイルを指定
      (デフォルト:インストールパスのconf.json または conf.json.EXAMPLE)
    • ファイル形式:JSON形式・単一オブジェクトをエクスポートするCommonJSモジュール

参考ファイル

【conf.json.EXAMPLE】

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": true
        }
    }
}

【CommonJSモジュール】

'use strict';

module.exports = {
    plugins: ['plugins/markdown']
};

設定項目

構成オプションデフォルト値備考
optsdestination文字列出力パス
(起動オプション:-d・--destination)
encoding文字列ソースファイルのエンコード形式
(起動オプション:-e・--encoding)
recurse文字列ディレクトリ再帰走査
(起動オプション:-r・--recurse)
template文字列テンプレートのパス
(起動オプション:-t・--template)
tutorials文字列チュートリアルファイルのディレクトリ
(起動オプション:-u・--tutorials)
plugins文字列配列[ ]プラグイン
recurseDepth数値10再帰検索の深さ
sourceexclude文字列配列処理対象外のパス
excludePattern正規表現"(^|\\/|\\\\)_"
_ (アンダーバー)で始まるファイル・ディレクトリ
処理対象外のファイルパターン
include文字列配列処理対象のパス
includePattern正規表現".+\\.js(doc|x)?$"
拡張子が .js・.jsdoc・.jsx のファイル
処理対象のファイルパターン
sourceType文字列"module"コード解析
"module":通常
"script":厳格モード
tagsallowUnknownTagsbooltrue不明なタグの使用可否
dictionaries文字列配列["jsdoc","closure"]有効タグ
templatescleverLinksboolfalse {@link}【インラインリンク】のプレーンテキスト表示の有無
default

【ユーザ定義】
includeDateboolフッタ部の作成日時の出力有無
layoutFile文字列レイアウトファイル名
(相対パスの指定は、コンフィグファイルのパス または JSDoc のパスが基準)
参照:レイアウト変更
outputSourceFilesboolソースファイルへのリンク有無
staticFilesexclude文字列配列出力ディレクトリにコピーさせないパス
excludePattern正規表現出力ディレクトリにコピーさせないファイルパターン
include文字列配列出力ディレクトリにコピーする静的ファイルのパス
includePattern正規表現出力ディレクトリにコピーする静的ファイルのファイルパターン
useLongnameInNavboolナビ部のロングネーム表示有無
monospaceLinksboolfalse{@link}【インラインリンク】の等幅フォント表示の有無

関連


パッケージファイル

メモ

  • プロジェクト名・バージョン等の情報を含むパッケージファイル

参考ファイル

{
    "name": "project name",
    "version": "1.2.3"
}

設定項目

キー必須出力有無備考
"name"ありプロジェクト名
"version"ありバージョン
その他情報なし任意

関連


READMEファイル

メモ

関連


テンプレート

メモ

関連


チュートリアルファイル

メモ

定義ファイル

【形式1】

{
  "tutorialA": {
    "title": "【チュートリアルAのタイトル】",
    "children": {
      "tutorialA1": {
        "title": "【チュートリアルA1のタイトル】"
      },
      "tutorialA2": {
        "title": "【チュートリアルA2のタイトル】"
      }
    }
  },
  "tutorialB": {
    "title": "【チュートリアルBのタイトル】"
  }
}

【形式2】

{
    "tutorialA": {
        "title": "【チュートリアルAのタイトル】",
        "children": ["tutorialA1", "tutorialA2"]
    },
    "tutorialB": {
        "title": "【チュートリアルBのタイトル】"
    },
    "tutorialA1": {
        "title": "【チュートリアルA1のタイトル】"
    },
    "tutorialA2": {
        "title": "【チュートリアルA2のタイトル】"
    }
}

関連