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

[Malte Jansen]

Hi!

Karsten Dambekalns schrieb:
> 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.

There cannot be any number of classes in one file, because it's one auf 
the rules that just one class is allowed in one file .

If There is just one Comment. Where does a DocComment belong? To the 
file or to the class.
Could it be used for both? Primary for the File, but if there is a 
class, for the too?
In 99% it's pretty much the same as for the class.

Cheers,

Malte