[TYPO3-team-core-v5] More documentation details...

[Robert Lemke]

Hi you again,

Am 28.05.2008 um 12:35 schrieb Karsten Dambekalns:

> Me again...
>
> This time I stumbled over the use of @author in a class-level  
> docblock.
>
> We don't do this, as the magic happens in methods, thus every method  
> must have an @author annotation. But... if we create an interface,  
> there are no methods that do anything. Instead it is about the  
> interface as such.
>
> I would therefore suggest to make use of @author tags in a class- 
> level docblock mandatory for interfaces. What do you think?

yes, that's the (yet unwritten) rule I used.

> And what about Exceptions, here the naming and hierarchy does the  
> job. handle like interfaces?

I'd say no. If they are just extensions of another exception but  
without any additional logic, I would not tag it with any author. If  
they do contain additional logic (which some will) let's tag the  
methods with the author's name.

robert
-------------- 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/20080529/139096d9/attachment.pgp