Subject: Re: ZAP/[patch] Martin's cursor position POW
From: Thomas Fletcher (thomasf@qnx.com)
Date: Fri Jan 26 2001 - 07:09:12 CST
On Fri, 26 Jan 2001, Mike Nordell wrote:
> Yes. Jesper has done the dirty work and now it's hopefully gaining
> accepance. If we do decide on this commenting style I'd like to see an
> update ASAP to the guidelines.
>
> But, I have one comment: When commenting functions in source code it looks
> really nice with the following
>
> //
> // This function does blah blah blah
> // It returns UT_FALSE on error
> //
> UT_Bool foo()
> { }
>
> I.e. leading and trainling "//" on their own lines (it's a sort of an
> enforced vertical whitespace, and as we all know whitespaces are good).
> You'e of course free to add any number of lines to the comment as long it
> contains one trainling single-line-C++-comment as its first chars.
>
The only thing that I don't like about using // for long
block comments is that it is a pain to have to edit them
since you always have to be doing formatting work. I'd
rather that we use the
/*!
This is a long block
comment of some sort ...
blah blah blah
*/
Rather than having to use
///
/// This is a long block
/// comment of some sort
/// blah blah
///
(I think that the /// is what is needed for doxygen to get the
comment right?).
Then again ... maybe I'm just being petty.
Thomas
-------------------------------------------------------------
Thomas (toe-mah) Fletcher QNX Software Systems
thomasf@qnx.com Neutrino Development Group
(613)-591-0931 http://www.qnx.com/~thomasf
This archive was generated by hypermail 2b25 : Fri Jan 26 2001 - 07:09:20 CST