まず、何APIDOCこと？
apidocは自動的にAPIインタフェースのドキュメントを生成するためのツールである、というシンプルな人気のポイント。このようなC＃、Java（登録商標）は、JavaScript、PHPなど、多言語インターフェースのドキュメント生成をサポートし 、Pythonの詳細については、を参照してくださいなど、公式ドキュメント。Javaコードはapidoc注釈で実現することができます。
二、APIDOCインストール
1. apidocのNode.jsのが依存するので、あなたは最初のNode.jsをインストールする必要があるため
2. apidocをインストールします。
Runコマンドボックスを開くためにcmdを、コマンド入力NPMは-g apidocをインストールし、インストールします。
コマンドの使用-h apidocをインストールが成功したことを確認します。
三、APIDOCの使用
1.設定のapidoc.json
Apidoc.jsonファイルをプロジェクトに作成され、プロジェクトの場所は、ルートディレクトリ（srcディレクトリと同じレベル）で推奨されて、あなたはまた、選択することができます。
次のように内容の例apidoc.json：
1 { 2 "名"： "プロジェクト名" 、 3 "バージョン"： "プロジェクトバージョン" 、 4 "説明"： "プロジェクトの説明" 、 5 "タイトル"： "ブラウザのタイトル" 、 6 "URL"：「API接頭辞パスの前に、経路を自動的@apiにスプライスされた空の文字列に設定することができる「 7 }
具体的な設定パラメータの名前とその意味はを参照してください公式文書
2. インタフェースはapidocコメントを追加します
具体的な設定パラメータの名前とその意味はを参照してください公式文書
3.インタフェースのドキュメントを生成
実行コマンドボックスオープンCMD、ディレクトリapidoc.jsonにcd使用apidoc -iのsrc / -o apidocは/インターフェースのHTMLドキュメントの形式を生成します
コマンドパラメータ詳細リスト：
| パラメータ | 説明 |
| -h、--help | 私たちのヘルプドキュメント |
| -f --file-フィルタ | 指定されたファイル名フィルタは、以下のようなファイルの正規表現（複数指定することができます）読み：apidocの-f - "* \ JS＆QUOTを、-f＆QUOT; * TS＆QUOT ;; -f＆QUOT * \\ TS ......" .cljの.cls .coffeeた.cppは.cs .dart .erl .exs .GOの.groovy .inoの.java ??：fは ".. * tsが" 唯一のjsサフィックスTSファイルとデフォルト値を読み出します。 JS .jsxの.kt .litcoffee LUA .Pの.php？.plの.PMの.py .RB .scala .TS .vue |
| -e --exclude-フィルタ | （複数を指定することができます）正規表現をフィルタリングし、指定したファイル名を読んなどしないでください：apidoc -e「.. * \ Jsの$は、」ファイルのjsサフィックスデフォルトを読み取れません意味： 『』 |
| -i、--input | ディレクトリたとえば、ソースファイルが読み込まれ、指定：apidoc -i myappのリード/ライトは、myappの/ソースファイルディレクトリのデフォルトを意味します./ |
| -o、--output | DOC /出力-o apidocはdocディレクトリのデフォルトを文書化することを意味します。次のような出力ディレクトリ文書を指定します./のdoc / |
| -t、--template | テンプレートファイルには出力例を指定します。apidoc -t MyTemplateに/デフォルト：path.join（__ dirnameは、 '... /テンプレート/'）（デフォルトのテンプレート） |
| -c、--config | 例えば、コンフィギュレーション・ファイル（apidoc.json）を含むディレクトリを指定します。apidoc -c設定/デフォルト：./ |
| -p、--private | apidoc -p○デフォルト値：出力ドキュメントは、独自のAPIの例が含まれているかどうかはfalse |
| -v、--verbose | apidoc -v○デフォルト値：次のような出力するかどうかのデバッグ情報の詳細はfalse |