問題タブ [phpdocumentor2]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
documentation - 自動コード文書化の問題 | PHP
多くのモジュールとコードが存在する CodeIgniter プロジェクトがあります。
今度は、他の新しい同僚のためにドキュメントを作成したいと思います。
例えば
次のコマンドで利用しました
I. PHPdoc
Ⅱ．アピジェン
コードの生成前または生成後にモジュールにコメントを追加することはできますか? ドキュメント自体の特定のモジュールにコメントを追加しようとしているので、必要に応じてソース コードの正しい位置に自動的に挿入されます。
プロジェクト内のモジュールとコードをどのように管理する必要がありますか? また、閲覧可能な HTML ドキュメントを作成するにはどうすればよいですか?
PHP ソース コードから直接ドキュメントを生成するその他のツール。
php - PHP コードを文書化するための公式 PHPDoc リファレンス
プロジェクトを PHP 8.0+ にアップグレードしようとしています。これまで、コード コメントでは、 "option 2"のように"option 1"@paramのように タグと@returnタグを使用していました。
オプション1：
@param string[] ....@return User[] ....
オプション 2:
@param array ....@return array ....
とはいえ、最初の形式が正式に許可されているかどうかわからないので、2 番目のオプションに切り替えた方がよいのではないかと自問し始めます.利用可能なPHPコードを文書化するための公式のPHPDocリファレンスはありますか?
また、2 番目のオプションの代わりに最初のオプションを使用することをお勧めしますか? 言い換えれば、それに反対する議論はありますか - 将来も念頭に置いていますか?
お時間をいただきありがとうございます。
PS : PHPDocumentorのリファレンスを見つけましたが、これは公式の PHP ではなく、(まだ) PHP 8.0+ と互換性がないと感じています。