[TYPO3-team-core-v5] Coding guidelines on one page

Karsten Dambekalns karsten at typo3.org
Wed Oct 8 11:56:45 CEST 2008


Hi.

Tim Eilers wrote:
> "File docblock followed by class
> docblock. Both are required!"
> 
> Ok, CGL say that, but why is it required?
> Will automatic documentation tools not run if there is only one of the
> two blocks? Or has it to do with the whole AOP / Reflection stuff?

No, it is to avoid countless entries in the phpDocumentor error log, 
which expects every file to be documented as well as every class.

That is because there could be any number of classes in a file, as well 
as non-OOP code.

Regards,
Karsten


More information about the TYPO3-team-core-v5 mailing list