apidoc phpインタフェースドキュメントの書き込み

716 ワード

1.apidocにはnodeが必要です.jsサポート、nodeのインストールが必要です.js 2.npmでapidocをインストールする
npm install apidoc -g

3.プロジェクトディレクトリにapidoc関連情報を作成します.一般的にはルートディレクトリの下にあります.この例はルートディレクトリの下にあるdocsフォルダです.
4.docsディレクトリの下で、対応する具体的なインタフェース情報xxxを作成する.jsは、対応するテンプレートファイルapidocを作成する.json(footer.md,header.mdを独立して書く必要がある場合は、この2つのファイルを作成する必要があります).次のコマンドを実行して、指定したディレクトリにドキュメントを生成します.
apidoc -i docs/  -o web/docs -t docs/

ルートディレクトリのdocs/フォルダのxxxに従います.jsファイルはdocs/apidocに基づいてドキュメントインタフェースの具体的な情報を生成する.jsonは、ドキュメントのヘッダと末尾の説明情報を生成します.
生成されたコンテンツはweb/docsディレクトリの下にあります.
6.文書情報、またはテンプレート情報を変更するたびに、5コマンドを実行して文書を再生成する必要があります.具体的なドキュメントとテンプレートのフォーマットは、公式ドキュメントを参照してください.http://apidocjs.com/