[Live-devel] LIVE555 code standard: comments

[Ross Finlayson]

>When commenting LIVE555 code, is it prefered to have the comment 
>blocks appear after the code block or function definition the 
>comment block pertains to?

It depends.  If the comment is of the form
	// We're about to do X
then I usually put it before.  If the comment is of the form
	// We just did X, because Y
then I usually put it after.

>Are larger comment blocks using // prefered over /* */ ?

Yes, because // blocks are easier to edit.

>   What about Doxygen comments?  ( /** @class **/ ?)

I don't use those.  From what I can tell, Doxygen does a good job already.
-- 

Ross Finlayson
Live Networks, Inc.
http://www.live555.com/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.live555.com/pipermail/live-devel/attachments/20070607/8b2ecd68/attachment.html