<!doctype html public "-//W3C//DTD W3 HTML//EN">
<html><head><style type="text/css"><!--
blockquote, dl, ul, ol, li { padding-top: 0 ; padding-bottom: 0 }
--></style><title>Re: [Live-devel] LIVE555 code standard:
comments</title></head><body>
<blockquote type="cite" cite><font size="-1">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?</font></blockquote>
<div><br></div>
<div>It depends. If the comment is of the form</div>
<div><x-tab> </x-tab>//
We're about to do X</div>
<div>then I usually put it before. If the comment is of the
form</div>
<div><x-tab> </x-tab>// We
just did X, because Y</div>
<div>then I usually put it after.</div>
<div><br></div>
<blockquote type="cite" cite><font size="-1">Are larger comment blocks
using // prefered over /* */ ?</font></blockquote>
<div><br>
Yes, because // blocks are easier to edit.<br>
</div>
<blockquote type="cite" cite><font size="-1"> What about
Doxygen comments? ( /** @class **/ ?)</font></blockquote>
<div><br></div>
<div>I don't use those. From what I can tell, Doxygen does a
good job already.</div>
<x-sigsep><pre>--
</pre></x-sigsep>
<div><br>
Ross Finlayson<br>
Live Networks, Inc.<br>
http://www.live555.com/</div>
</body>
</html>