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

[Tim Eilers]

Hi folks,

Karsten Dambekalns schrieb:
> I took Bastians comments and some of mine and added them to
>  http://forge.typo3.org/wiki/package-flow3cgl/FLOW3CGL
> to keep this in one place.

Ok, before i upload the next draft i have a question:

> @var tags have only type and variable name - description goes
> in the line before that

I do not really agree with that, you don't follow it in your own code.
While i could understand the part with 'description in line before' i
don't understand why to repeat the variable name?
Are you really really sure?

And another one:

> namespace must start with F3 for automagic stuff to work in component
> manager etc.. make the rule "Should start with F3 followed by package
> key (name) and subparts as needed"

I remember a very deep discussion about that 'F3' and Robert said he
doesn't want to make that a strong rule, because FLOW3 could use in own
projects with own namespaces. Does this have changed to a 'must' use of F3?

> Could you upload the source for the PDF to the Wiki as well?

I can. But it is not very plattform friendly (MS Word). Sorry, but i
didn't had a better idea. (Also, i am not the best in Open Office).

And it is simply too much, so i now have to call it "Coding Guidelines
on two pages". ;)


Cheers,
Tim.