MVC sollte ich Controller-Funktionen dokumentieren

Question

Ich habe etwas gefragt. Normalerweise benutze ich PHPDoc, um die Funktion zu dokumentieren. Dies erklärt, was die Funktion macht.

Meine Frage ist, sollte ich auch Funktionen in einem Codeigniter (oder einem MVC-Framework) -Controller dokumentieren? Die Funktionen werden hauptsächlich per Routing aufgerufen und dienen lediglich dazu, eine Seite anzuzeigen, sodass ich nicht weiß, ob es notwendig ist, sie zu dokumentieren.

Answer 1

Wahrscheinlich besser, wenn Sie es getan haben, denn die PHPDocs sind nicht nur für Sie, sondern auch für andere, die nach Ihnen kommen. Für sie (und für Sie) wäre es einfacher zu lesen, auf welcher Seite der Controller ist.

Nach der Verwendung eines Documentor-Tools gibt es Klassen und Methoden ohne Code, einschließlich derer, die kein phpdoc haben. Da auf diesen Seiten kein Code vorhanden ist, wäre es schwierig, herauszufinden, welcher Controller für welche Seite zuständig ist (auch wenn er vom Klassennamen ausgeht).