On Mon, Oct 21, 2002 at 10:41:02PM +0930, Darren Freeman wrote:
> Well actually if I had put more effort into it the comment block above
> the function would have described quite a bit, like what the return
> values are, what the parameters do, what to look out for, who should
> call it, etc.
> 
> But as I haven't seen a LyX standard comment block for this I decided to
> just wait on it.

Hopefully forever ;-)

No comments are better than comments that are out-of-sync with the code.
Make the code explain itself rather than trying to describe the code in
another language...

Andre'

-- 
Those who desire to give up Freedom in order to gain Security,
will not have, nor do they deserve, either one. (T. Jefferson)

Reply via email to