#author("2022-04-27T07:10:37+00:00","default:admin","admin")
#author("2022-05-10T01:55:19+00:00","default:admin","admin")
*PHPDoc [#x7bf875b]
-[[PHPDoc リファレンス:https://zonuexe.github.io/phpDocumentor2-ja/references/phpdoc/index.html]]
-[[型を使いこなすためのPHPDocの書き方:https://tech-blog.rakus.co.jp/entry/20210326/php]]
-[[PHPDocコメント　まとめ:https://qiita.com/kouki_o9/items/49d34d347bde730f4a30]]

*コメントの書き方 [#ud3e0c1e]
-[[単一行コメント記号の直後にスペースを付けないのは「コメントアウトされたコード」を示す:https://neos21.net/blog/2019/11/14-01.html]]

-行頭スペースありのコメント行は、人間が読むためのコメント文を示す
--一般的にコメントを書く際は面倒臭がらずスペースを付けよう
-行頭スペースなしのコメント行は、コメントアウトされたコードを示す
--コメントアウト記号を取り外せば、そのままコードとして機能する行になっていることが望ましい

*ツール [#kb29b8bb]
**[[phpDocumentor:https://www.phpdoc.org/]] [#s0c3d342]
-[[phpDocumentorの使い方【コメントからドキュメント作成】:https://codelikes.com/php-documentor/]]

-PHPDocという記述形式でコメントを書いておくと、コメント部分をまとめてドキュメント生成してくれる

**[[phpDox:https://phpdox.net/]] [#e265aba9]
-PHPのソースコードから、例えば、HTML形式でAPIドキュメントを生成するためのドキュメントジェネレータ

**[[Doxygen:http://www.doxygen.jp/]] [#mfb08c14]
-C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風)、Fortran、VHDL、PHP、C# 向けのドキュメンテーション・システム
-文書化されたソースファイルのセットから、 オンライン・ドキュメント・ブラウザ (HTML形式) やオフラインのリファレンス・マニュアル (形式) を生成することができる
-RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、Unix man ページ形式の出力もサポート
-ドキュメントは、ソースから直接抽出される
-Doxygen は、文書化されていないソースファイルから、 コードの構造を抽出するように設定することができる
-様々な要素間の関係が、内包・依存図、継承図、 およびコラボレーション図により視覚化される（しかもすべて自動的に生成される）
-Doxygen を「乱用 (abuse)」して、 通常のドキュメントを作成することもできる
トップ   編集 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS