Coding Standard tools

mentel · March 1, 2012, 6:15pm

I didn’t think that the core team would need to have a public coding standard.

But now I agree with jacmoe because it will ease contributions to the framework and avoid this: https://github.com/golovanov/yii/commit/c2f496354804c8ad0892570585d692a95b9f5373.

A layout definition file can even make things easier.

jacmoe · March 1, 2012, 6:20pm

Yes, that is exactly the reason why I think it would be a good idea: to ensure that contributions are applied as cleanly as possible.

choiceerp · March 1, 2012, 6:26pm

choiceerp:

I agree to, if it’s not necessary to fix everythings, but just some rule to make the code more readable. If in 2 or 3 year I should get an old application with no rule, I whant not must be say; “put your work at trash and restart on another framework”.

In same time if i get the same project but from Symfony2 and is writted on the same way, I can’t say same and that just because Symfony2 have set writting rules and if the developper don’t follow and if the code isn’t readable, that mean the project manager is null and I put him in trash.

example of few rule:

no braces for single line statements (braces exist in order to group multiple lines, no multiple lines no braces)

space after conditions (they are not functions like f(x) )

private menber start by _ and not static member start in minus

indentation (space or tab, not problem but indent)

presence of doc generated automaticly (@param and @return minimum)

and that all (and i think that the minimum)

Just for exemple Yii framework + somes plugins (all needed by all my website on yii) give 120.495 errors and 23.379 warnings with the rule code of Symfony2 and beleave me I prefert Yii to Symfony2, but that avanche of error in rules desesperate me, spececialy by the extensions folder giving to me arrond 80.000 errors in rule. So Symfony2 is not clean with they hown rules and give 5.005 errors and 1.007 warnings with the demos download.

choiceerp · March 1, 2012, 6:41pm

Houps I forgot some directory for Symfony2 the good count is 36.473 errors and 7.980 warnings,

sensorario · March 2, 2012, 11:29pm

=)

Psih · March 5, 2012, 12:38pm

Some coding standards should be defined and acceptance to the package managing should be filtered through them. Take srbac module for example - it has ugly looking code and I have to put it through PHPStorm’s “Reformat code” before I try to do something with it.

Despite me using different conventions than Yii does, I have no problem reading that code (although lack of braces on single-line if’s and loops makes you read the code more carefully).