No, sorry, for me this doesn't make sense. For me it make no sense to write stuff in the documentation thats allready in the code, 'cause that get outdated very soon and might be rather confusing. Probably you can change the phpDocumentator that it makes something like this for the output. Just my two cents leo
-----Ursprüngliche Nachricht----- Von: JARUZ [mailto:[EMAIL PROTECTED] Gesendet: Dienstag, 25. September 2007 11:35 An: [email protected] Betreff: [fw-general] Inline Documentation for Controllers and Models (MVC) Hello again: Well, this time my question is regarding "Inline Documentation" and the MVC framework. It would be nice to define a standard way of writing the documentation for Controllers and Models in such a way that e.g. all Actions that a Controller has are documented in its docblock. The "B.4.7. Inline Documentation" chapter on the Reference Guide (http://www.zendframework.com/manual/en/coding-standard.coding-style.html#co ding-standards.inline-documentation) only goes as far as requiring dockblocks for Files, Classes and Functions, but does not require extended documentation when the Class is a Controller or a Model. I think it should. Anybody has suggestions as to how a Controller docblock should look like? /** * Controller in charge of doing this or that * * Actions: Index, SomeAction, AnotherAction. * * @copyright 2007 Myself * @license http://www.zend.com/license/3_0.txt PHP License 3.0 * @version Release: @package_version@ * @link http://dev.zend.com/package/PackageName * @since Class available since Release 1.2.0 */ Each Action (function within the Controller Class) would then have its own docblock documenting what it actually does. Do I make sense or am I just rambling? Cheers, Antonio -- View this message in context: http://www.nabble.com/Inline-Documentation-for-Controllers-and-Models-%28MVC %29-tf4514440s16154.html#a12876176 Sent from the Zend Framework mailing list archive at Nabble.com.
