php - ファイルの先頭に関数リストを含めることをお勧めします

Question

PHP ファイルの先頭に (コメント セクションに) 関数のリストを含めるのは良い習慣ですか?

Answer 1

いいえ。 - PHPDocを使用することをお勧めします。

Answer 2

はい、このファイルが使用している機能を理解するのに役立ちます。

また、実際の関数コードの前に、どのパラメーターとどの戻り値の型があるかをコメントアウトする必要があります。

Documentor (PHPDOC) での php コメント標準のベスト プラクティスについては、こちらをお読みください。

コメントなしの Jeff atwood のコーディングとWhen Good Comments Go Badの投稿は、コメント戦略に役立ちます。