Coding Standard

(Difference between revisions)
Jump to: navigation, search
(Doxygen Comments)
(Doxygen Comments)
Line 31: Line 31:
 
=== Doxygen Comments ===
 
=== Doxygen Comments ===
  
Stellarium source code should be document with [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen]. From Doxygen webpage:
+
Stellarium source code should be documented with [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen]. From Doxygen webpage:
  
 
<i>"Doxygen is a documentation system for C++, C, Java, [...] It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in LaTeX) from a set of documented source files. [...] The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. [...] You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.</i>
 
<i>"Doxygen is a documentation system for C++, C, Java, [...] It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in LaTeX) from a set of documented source files. [...] The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. [...] You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.</i>
  
There are different way to comment C++ code with Doxygen, in Stellarium use the following:
+
All public and protected classes and methods from Stellarium should be fully documented in the headers (.h).
 +
 
 +
There are different ways to comment C++ code with Doxygen, in Stellarium use the following for headers files:
  
 
  //! Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name
 
  //! Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name
Line 42: Line 44:
 
  //! @return a vector of matching object name by order of relevance, or an empty vector if nothing match
 
  //! @return a vector of matching object name by order of relevance, or an empty vector if nothing match
 
  vector<wstring> listMatchingObjectsI18n(const wstring& objPrefix, unsigned int maxNbItem=5) const;
 
  vector<wstring> listMatchingObjectsI18n(const wstring& objPrefix, unsigned int maxNbItem=5) const;
 +
 +
for methods definitions in .cpp files, a simpler comment for each method is sufficient:
 +
/*************************************************************************
 +
  Find and return the list of at most maxNbItem objects auto-completing the
 +
  passed object I18n name
 +
*************************************************************************/
 +
vector<wstring> listMatchingObjectsI18n(const wstring& objPrefix, unsigned int maxNbItem=5) const
 +
{
 +
    etc..
  
 
=== C/C++ code ===
 
=== C/C++ code ===

Revision as of 16:07, 26 September 2006

The increasing number of contributors require that we clearly define coding rules and guidelines. Although for historical reasons the current code of Stellarium does not always comply to these rules, they should now be respected for any addition or modification of the code.

Contents

Stylistic Conventions

  • Source code should use ASCII character set. Characters such as 'é' or 'ö' are not portable when hardcoded. Gettext translated strings should be used for such characters.
  • Variable names and comments should be in english.
  • Class names are nouns, in mixed-case, with an initial upper-case letter and the first letter of each subsequent word capitalized (e.g. CoreFactory).
  • Method names are verbs or nouns in mixed-case, starting with a lower-case letter (e.g. update() or addElement()).
  • Methods that return a value should take the form getSize().
  • The names of local variables should be in mixed case, starting with a lower-case letter (e.g. packetSize). This also applies to the formal parameters of methods. Do not use names starting with underscore.
  • The names of macro or static final constants should be all upper-case words, separated by underscore:
#define MIN_WIDTH 3
static const string VERSION = "0.8.2";
  • Indentation should be done with tabs, not spaces. This allows each developers to use his favorite indent size without changing the code.
  • Use the following layout for braces:
void MyClass::myMethod(int x)
{
   if (x>10)
   {
      cout << "You won." << endl;
   }
}
  • Use blank lines as follows:
    • 1 between methods, before (block or single line) comment
    • 1 between logical sections of a method
    • 2 between sections of a source file

Doxygen Comments

Stellarium source code should be documented with Doxygen. From Doxygen webpage:

"Doxygen is a documentation system for C++, C, Java, [...] It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in LaTeX) from a set of documented source files. [...] The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. [...] You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.

All public and protected classes and methods from Stellarium should be fully documented in the headers (.h).

There are different ways to comment C++ code with Doxygen, in Stellarium use the following for headers files:

//! Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name
//! @param objPrefix the case insensitive first letters of the searched object
//! @param maxNbItem the maximum number of returned object names
//! @return a vector of matching object name by order of relevance, or an empty vector if nothing match
vector<wstring> listMatchingObjectsI18n(const wstring& objPrefix, unsigned int maxNbItem=5) const;

for methods definitions in .cpp files, a simpler comment for each method is sufficient:

/*************************************************************************
 Find and return the list of at most maxNbItem objects auto-completing the 
 passed object I18n name
*************************************************************************/
vector<wstring> listMatchingObjectsI18n(const wstring& objPrefix, unsigned int maxNbItem=5) const
{
    etc..

C/C++ code

Use C++ replacement for C functions wherever possible. This includes the following:

  • use std::string instead of char*
  • use iostream C++ classes instead of C file managment with fopen().
  • pass objects as references when needed instead of using pointers.
  • include standard headers the C++ way, it is more portable:
#include <stdio.h> // Bad

#include <cstdio>  // Good
  • Avoid using pointers when not needed, this prevents creating memory leaks. For example:
string mapFileName = getDataDir() + "fontmap.dat";

ifstream *mapFile = new ifstream(mapFileName.c_str());  // Bad

ifstream mapFile(mapFileName.c_str());                          // Good
  • Use STL containers such as std::vector or std::map, they are extremely efficient. Documentation is here.
  • Avoid using global function and variable. Encapsulate them in classes or namespaces as static members/variable.

Translatable strings and text console output

In Stellarium, translatable text is translated using the Translator class, which is a C++ wrapper to gettext. The translation process is done using the _() macro which takes in input a std::string in english and return in output a std::wstring (a string of wide characters) translated in another langage using the current global langage.

  • Translatable text in sources or in data files should be written in english, encoded in ASCII or UTF-8 if needed.
  • Translatable text should obey english typo conventions, for example there should be no space before ':'
wstring myTranslatedText = _("Distance of the planet :") // Bad

wstring myTranslatedText = _("Distance of the planet:")  // Good
  • When modifying the code, avoid to modify translatable string unless really needed. Any modification on one of them means that all the translators for all the langages will have to re-translate the new string.
  • In general no translated text (i.e. no wstring) should be output on the console because there are problems when string and wstring are output on the same console. This means that you should never use wcout, wcerr or wprintf(). Console output should be used for informations, errors and warnings which are not required by the user in nominal use.
  • Errors and warnings should be output in the stderr file, not stdout.
cout << "Error while opening file " << myFileName << "." << endl; // Bad

cerr << "Error while opening file " << myFileName << "." << endl; // Good
Personal tools
Namespaces
Variants
Actions
in this wiki
other languages
Toolbox