MVCはコントローラ機能を文書化する必要があります

Question

私は何か不思議でした。通常、私は関数を作成するときにPHPDocを使ってその関数を文書化します。これは機能が何を説明する。

私の質問は、Codeigniter（または任意のMVCフレームワーク）コントローラの関数についても書かなければならないのですか？同様に、関数は主にルーティングによって呼び出され、ページを表示するだけなので、文書化する必要があるかどうかはわかりません。

Answer 1

PHPDocはあなたのためだけでなく、あなたの後に来る他の人にとっても、おそらくあなたの方が良いでしょう。彼ら（そしてあなた）のために、コントローラがどのページを読み込むのが簡単でしょう。

ドキュメントツールを使用した後、phpdocを持たないものも含め、コードのないクラスとメソッドがあります。これらのページにはコードがないので、どのコントローラがどのページであるかを知ることができます（ただし、クラス名に付随している可能性があります）。