php - 大規模なプロジェクトを文書化するために使用するツールは何ですか?

Question

私は友人と一緒にプロジェクトに取り組んでいます。このプロジェクトは大きくなり、多くのクラス、メソッド、関数、ヘルパーなどがあります..

他のコードを読むのに役立つ何かが必要だと感じています。プロジェクトは公開フレームワーク (laravel) で構築されており、MVC です。

これに役立つツールを使用していますか？コードは文書化されていますが、すべてのファイルを読んで物事がどのように機能するかを知るのは少し難しいと思います.

ありがとうございました。

Answer 1

phpDocが役立ちます。次のように、すべての関数の前にコメントを設定します。

/**
 * Returns a user's e-mail address
 * 
 * @param int $userId
 * @return string
 */

ほとんどの主要な IDE はこれらを読み取るため、コード補完を介して関数を呼び出すと、戻り値の型を確認できます。