phpdoc/phpDocumentor を使用して API ドキュメントを生成する

phpDocumentor は非常に強力な自動ドキュメント生成ツールであり、標準化されたコメントを作成し、理解しやすく明確な構造のドキュメントを生成するのに役立ちます

コードのアップグレード、メンテナンス、引き継ぎに大きな影響を与えます。などが役に立ちます。

インターネット上には phpdoc ドキュメントの紹介がたくさんありますが、少し面倒です:

1. 通常、インターネット上で紹介されているコンテンツが多すぎて、初心者にとっては理解するのが簡単ではありません。個人的には、チュートリアルは問題を解決できる限り、シンプルで理解しやすいものであるべきだと考えています。

より多くのコンテンツは付録の形式にするか、読者が読めるように他のより詳細な情報へのリンクを残す必要があります (大きな部分を自分の記事にコピーする代わりに)

2. phpdoc のインストールは少し面倒です。シンプルで使いやすい方法を読者に紹介したわけではありません

3. phpdoc のデフォルトのエンコーディングは ISO-8859-1 であり、生成された HTML ドキュメントは中国語で文字化けします。インターネット上で利用できる解決策はありますが、中国語をサポートするバージョンを読者に直接提供してはどうでしょうか?

上記の点を踏まえて、phpdoc の簡単な使用方法 (Windows 環境下) を共有するためにブログ記事を書きたいと思います

phpdoc を使用する前に、まずコード コメントの文法規則を理解する必要があります (すでに理解していますので無視してください）。

Wikipedia http://zh.wikipedia.org/wiki/PHPDoc の注釈形式の説明を参照してください。

次に、この最適化された phpdoc バージョンをダウンロードできます:

http://star7th-wordpress.stor.sinaapp.com/uploads/2013/04/phpdoc.zip

たとえば、ダウンロード後に解凍します。パス「D:/phpdoc」に解凍します。

テキスト エディタで phpdoc.bat を開きます (ダブルクリックして実行しないように注意してください)、行 16:

SET phpCli=D:Program Filesphp5.3.11php.exe

ここで PHP.exe のパスを次のように変更します。あなたのコンピュータ PHP 環境実行ファイルが配置されているパス。 (PHPer であれば、ローカル マシンに php 環境をインストールしていると思います。)

次に、コマンド プロンプトを開きます。 ([スタート]-[ファイル名を指定して実行]-[cmd])、コマンド ラインで、phpdoc が存在するディレクトリを入力します (たとえば、「cd D:/phpdoc」と入力します)。

ディレクトリに入ったら、次のコマンドを入力して HTML ドキュメントをすばやく生成します:

phpdoc -d D:websiteApi -t D:websiteApidoc -dn shilianwang -dc shilianwang -ti IoT Document -o HTML:Smarty:PHP

上記のコマンドの D:websiteApi は、ソース php ファイルが配置されているディレクトリです。 D:websiteApidoc は、生成されたドキュメント保存ディレクトリです。

shilianwang は、サブディレクトリ、パッケージ、およびタイトルです。 HTML:Smarty:PHP とは、HTML モジュールを使用して

を生成することを意味します。詳しく知りたい場合は、コマンド ラインで phpdoc -h と入力すると、詳細を確認できます。

最後に、3 つのレンダリングが添付されます:

コメント スタイル:

このコメントによって生成されたレンダリング:

PhpDocumentor マニュアル - インストールとラベル付けの使用

ご清聴ありがとうございますウェブサイトブログ!