> It seems that the only disputed issue regarding style is whether a tab- key
> press should insert spaces (bullet-proof) or a \t.
I'm happy with a mandatory space rule. It's more likely to result in
consistently formatted code.
> On Thursday 11 December 2008 22:41:13 Matthew Mundell wrote:
> > Firstly, the example in CR 19 is quite close to the GNU standard. How
> > about just adopting the GNU standard entirely? Then the documentation
> > could just refer to that standard, and the code format will match at least
> > some code in other projects.
> Adopting e.g. the GNU coding standards would make things easier to settle.
> But I find them somewhat strict and personally, I find my example
> more "aesthetic" than what would follow the GNU guide, but for sake of an
> agreement I really do not care (tell me you love it and I vote +1).
I love it, if only to force the adoption of an existing standard.
> > - conditional and loop blocks are indented. (Is it common practice to
> > indent these blocks in the same way as function definitions, as in the
> > example?)
> I prefer
> --
> func()
> {
> //indented
> --
> and
> --
> if()
> {
> // indented
> --
> only argument: more pleasant to read (habits, see above).
I think this is a very rare style, and adopting a more common style has
more benefit.
> > Secondly, how about turning on Doxygen JAVADOC_AUTOBRIEF? This allows
> > forms such as
> >
> > /** Free any server rules. */
> > void
> > maybe_free_server_rules ()
> > ...
> >
> > in place of
> >
> > /**
> > * @brief Free any server rules.
> > */
> > void
> > maybe_free_server_rules ()
> > ...
>
> I have seen you doing it in the Manager.
> They are non-exclusive, so imho autobrief can be turned on.
> I think its an ok solution for one-liners.
> Otherwise i find a
> --
> /**
> * @brief You get what I do in one sentence.
> * If not, read me.
> ...*/
> --
> easier to grasp - I am just more familiar with it that way.
> To be honest generally I do not like stuff behind the double star :) .
I think it would be cleaner and more manageable to format every single
documentation comment exactly the same way. I'll happily use the @brief
style if it's chosen, although I think the autobrief style in neater and
easier to read.
_______________________________________________
Openvas-devel mailing list
Openvas-devel@wald.intevation.org
http://lists.wald.intevation.org/mailman/listinfo/openvas-devel
