[RFC] Coding Style: Function header comments?

[Jeremy Allison]

On Wed, Nov 28, 2007 at 07:23:11PM +0100, Jelmer Vernooij wrote:
> There is currently nothing in the coding style guide about comments
> above functions, explaining in one or two lines what the function does.
> It would be nice to have a standard for this as well. 
> 
> So far, I've encountered the following styles:
> 
> /* Foo bar */
> 
> This is nice and short but has the disadvantage that it is
> indistinguishable from any regular comment.
> 
> /************************************************************************
>  * Foo bar
>  **********************************************************************/
> 
> This is too much typing, and all the asterisks have no use imho :-)

I like this style. It clearly separates out the function headers
for me.

Jeremy.