MVC devrais-je documenter les fonctions du contrôleur

Question

Je me demandais quelque chose. Habituellement quand je fais une fonction, j'utilise PHPDoc pour documenter la fonction. Ceci pour expliquer ce que fait la fonction.

Ma question est, devrais-je également documenter les fonctions dans un contrôleur Codeigniter (ou n'importe quel cadre MVC)? Comme, les fonctions sont principalement appelées par routage et sont juste pour montrer une page, donc je ne sais pas s'il est nécessaire de le documenter.

Answer 1

Probablement mieux si vous l'avez fait, comme les PHPDoc ne sont pas seulement pour vous, mais aussi pour d'autres qui viennent après vous. Pour eux (et vous), il serait plus facile de lire à quelle page le contrôleur est destiné. Après l'utilisation d'un outil de documentation, il y aura des classes et des méthodes sans code, y compris celles qui n'ont pas de phpdoc. Comme il n'y a pas de code sur ces pages, vous serez pressé de découvrir quel contrôleur est pour quelle page (bien qu'il puisse être apperant du nom de la classe).