Re: [Wxdevide-devs] Coding Guidelines

[Tony R. <tb...@gm...>]

That's a nice start. I'd like to add:

C++ header files end in .H and source files end in .Cpp

Each file should begin with the $Id tag, original author, and license tag

Every include file must contain a mechanism that prevents multiple
inclusions of the file. For example, the following should follow the header
information for the NOX_Abstract_Vector.H header file.

#ifndef NOX_ABSTRACT_VECTOR_H
#define NOX_ABSTRACT_VECTOR_H

*...body of include file goes here...*

#endif


If the arguments of a function don't fit into the 80 chars, start a new line
and align the additional arguments with the first one.

For if, else, while and similar statements put the brackets on the same line
as the statement (this makes it easier to see if the IDE has a matching
braces tool)

Each public function must have a Doxygen compatible comment in the header

Use true and false instead of TRUE and FALSE.

-Tony




On Thu, Oct 2, 2008 at 12:55 PM, so...@ti... <so...@ti...>wrote:

> I have posted a basic guide on the wiki with the contents of
> discussions so far. To get more feedback on the guidelines I have a
> list of other projects guidelines. I particularly like some of the
> ideas of the NOX project.
>
> http://pim.kde.org/development/coding-korganizer.php
> http://developer.gnome.org/doc/guides/programming-guidelines/code-
> style.html<http://developer.gnome.org/doc/guides/programming-guidelines/code-style.html>
> http://trilinos.sandia.gov/packages/docs/r4.
> 0/packages/nox/doc/html/coding.html<http://trilinos.sandia.gov/packages/docs/r4.0/packages/nox/doc/html/coding.html>
>
> Sof.T
>
>
>
>
> See your new look Tiscali Homepage - http://www.tiscali.co.uk
>
> ___________________________________________________
>
>
> -------------------------------------------------------------------------
> This SF.Net email is sponsored by the Moblin Your Move Developer's
> challenge
> Build the coolest Linux based applications with Moblin SDK & win great
> prizes
> Grand prize is a trip for two to an Open Source event anywhere in the world
> http://moblin-contest.org/redirect.php?banner_id=100&url=/
> _______________________________________________
> Wxdevide-devs mailing list
> Wxd...@li...
> https://lists.sourceforge.net/lists/listinfo/wxdevide-devs
>