Coding Standard

From Stellarium Wiki
(Difference between revisions)
Jump to: navigation, search
m (Reverted edits by Alicethomas (talk) to last revision by Daggerstab)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
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.
+
Please see http://www.stellarium.org/doc/head/codingStyle.html
  
== Stylistic Conventions ==
+
[[Category:Development]]
 
+
*Source code should use ASCII character set. Characters such as 'é' or 'ö' are not portable when hard-coded. 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 const 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
+
 
+
== File Names ==
+
 
+
The extensions are .hpp/.cpp for C++ headers/code, .h/.c for C headers/code.
+
C++ files should have the same name and case than the class they contain. For example class StelFontMgr should be declared in file StelFontMgr.hpp and implemented in StelFontMgr.cpp.
+
 
+
== Doxygen Comments ==
+
 
+
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>
+
 
+
All public and protected classes and methods from Stellarium should be fully documented in the headers (.hpp).
+
 
+
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;
+
 
+
Brief descriptions are single line only, and stop at the first full stop (period).  Any subsequent sentences which occur before @param or a similar tag are considered to be part of a detailed description.
+
 
+
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 QString (from Qt) instead of [http://www.sgi.com/tech/stl/basic_string.html std::string] or  char *
+
*Use [http://www.cplusplus.com/ref/iostream/ 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 [http://www.sgi.com/tech/stl/ here].
+
*Avoid using global function and variable. Encapsulate them in classes or namespaces as static members/variable.
+
*Avoid using C macro, use static const variables instead. It is safer because it is type safe.
+
#define RADIUS 12 // Bad
+
static const int RADIUS = 12;
+
 
+
*Use stdc++ math functions instead of C ones. There are more protable and are also overrided for float, thus may be faster.
+
double cosLat = cos(lat);    // Bad
+
double cosLat = std::cos(lat); // Good
+
 
+
== Translatable Strings and Console Output ==
+
 
+
Translatable strings are translated using the Translator class, which is a C++ wrapper around gettext. The strings should be marked using the <tt>q_()</tt> macro: it takes a QString in English and returns the translation as a QString using the current global language.
+
*Translatable text in sources or 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 the colon:
+
QString myTranslatedText(q_("Distance of the planet :")); // Bad
+
QString myTranslatedText(q_("Distance of the planet:"));  // Good
+
 
+
*Translatable strings should be modified only if really necessary. Any modification to 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
+
 
+
==Tab and Space Indentation Method==
+
 
+
When wrapping lines from long function calls, where the wrapped line does not start at the same level of indentation as the start of the function call, tab up to the start of the function call, and then use spaces to the opening parenthesis.
+
 
+
[--tab-][--tab-][--tab-]someFunction(param, ...
+
[--tab-][--tab-][--tab-][  spaces  ]moreparams, ...);
+
 
+
This method will handle different tab widths gracefully.
+
 
+
==Automated Code Formatting==
+
 
+
You can use the [http://astyle.sourceforge.net/ astyle] program to format your code according to these conventions.  Use the following options:
+
astyle --style=ansi -tU source.cpp
+
 
+
Note that this command will replace the file '''source.cpp''' with the re-formatted one, and create a backup of the original with the .orig suffix.  Also note that the -U option (used to un-pad parenthesis) is only available recent version of astyle.
+

Latest revision as of 19:12, 15 March 2011

Please see http://www.stellarium.org/doc/head/codingStyle.html

Personal tools
Namespaces
Variants
Actions
in this wiki
other languages
Toolbox