apidoc windowsでのインストール使用チュートリアル

748 ワード

1.nodejsのインストール
32ビットインストールパッケージのダウンロードアドレス:https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi
64ビットインストールパッケージのダウンロードアドレス:https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi
2.apidocをインストールし、
npm install -g apidoc
npm nodejsのインストールに成功した後にこのコマンドがあります
3.cdからドキュメントを生成するjavaディレクトリを指定します.apidocの実行
ディレクトリの下にdocドキュメントが生成されます
4.文書の内容のサンプルを設定し、文書を生成する前に、そのディレクトリの下にapidocを追加することができる.jsonファイル、内容:
{ 
  "name": "example", 
  "version": "0.1.0", 
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title", 
  "url" : "https://api.github.com/v1"
}

コメントコードについては、公式サイトを参照してください.