[TYPO3-team-core-v5] FLOW3: First code sprint of F3PR

[Robert Lemke]

Hi Malte,

Am 16.09.2008 um 09:46 schrieb Malte Jansen:

>> I vote for "not allowed". In my opinion, if someone needs to write a
>> multi-line
>> inline comment, there's something wrong with the code.

> in FLOW3CGL we some longer comments, because we have added some
> information, about why it is handled in a certain way. Sometimes the
> code might be easy to understand, but the idea behind should be  
> mentioned.

Yes, explaining the "why" is probably the only valid reason for  
writing inline
comments. However, explaining the "what" is considered to be a bad  
code smell [1].

Anyway, I guess that longer documentation should better end up in the  
doc comment
part than in the code.

robert

[1] http://c2.com/xp/CodeSmell.html
-------------- next part --------------
A non-text attachment was scrubbed...
Name: PGP.sig
Type: application/pgp-signature
Size: 186 bytes
Desc: This is a digitally signed message part
Url : http://lists.netfielders.de/pipermail/typo3-team-core-v5/attachments/20080916/b55f7560/attachment.pgp