[Phpmyadmin-devel] On the @uses comment tag

[Michal Čihař]

Hi

Dne Tue, 21 Jun 2011 07:52:31 -0400
Marc Delisle <marc at infomarc.info> napsal(a):

> Michal Čihař a écrit :
> > Hi
> > 
> > Well there are many ways to remove it, but the question is whether we
> > want to :-).
> 
> I am reluctant to remove all @uses but I agree to remove the reference 
> to internal PHP functions.
> 
> Of course it's more work to maintain but I think that if we adhere to 
> phpDocumentor principles, we should use @uses. Many people need to work 
> with the source code and understand it.

I still fail to see what added value does it bring - somebody reading
documentation and looking what function does does not really care what
it uses underneath. For somebody working with the code, it only brings
extra effort to keep it up to date.

-- 
	Michal Čihař | http://cihar.com | http://blog.cihar.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: not available
URL: <http://lists.phpmyadmin.net/pipermail/developers/attachments/20110621/e396d61a/attachment.sig>