"Ed Price" <ed.price@gmail.com> writes:
> Actually, I realize now that "properly" capitalizing acronyms in all
> comments would conflict badly with what appears to be commonly
> followed (internal) comment style in which parameter names are written
> in all caps. For example:
>
> /* Tweak the entry NAME within hash ENTRIES. If NEW_URL is non-null,
> * make this the entry's new url. If NEW_REV is valid, [...]
>
> Changing "url" to "URL" there would be a bad idea.
FWIW, we often still use upper-case acronyms in such doc strings, even
though they then look like they might be parameters. It hasn't seemed
to be a problem in practice, since one can always check a parameter
against the actual function definition. We don't seem to be
consistent about this, but I personally don't mind -- it's a minor
point.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sun Mar 12 21:22:00 2006