Coding Standard - Revision history

Daggerstab: Reverted edits by Alicethomas (talk) to last revision by Daggerstab

2011-03-15T19:12:28Z

Reverted edits by Alicethomas (talk) to last revision by Daggerstab

2011-03-15T12:31:55Z

2010-09-16T06:05:22Z

revert - please create a separate page with the translation

2010-09-15T23:31:22Z

2008-12-02T14:06:19Z

Replacing page with 'Please see http://www.stellarium.org/doc/head/codingStyle.html Category:Development'

2008-12-02T13:53:19Z

2008-06-26T14:01:32Z

Stylistic Conventions

2008-06-26T14:00:30Z

Stylistic Conventions

2008-06-03T17:42:09Z

2008-06-03T17:35:49Z

← Older revision		Revision as of 19:12, 15 March 2011
Line 2:		Line 2:

	[[Category:Development]]		[[Category:Development]]
−	* [http://www.designerevaluation.com/logo-design/ logo design]
−	* [http://www.designerevaluation.com/ website design]

← Older revision		Revision as of 12:31, 15 March 2011
Line 2:		Line 2:

	[[Category:Development]]		[[Category:Development]]
		+	* [http://www.designerevaluation.com/logo-design/ logo design]
		+	* [http://www.designerevaluation.com/ website design]

← Older revision		Revision as of 06:05, 16 September 2010
Line 1:		Line 1:
−	http://www.stellarium.org/doc/head/codingStyle.html ~~사이트를 참조하세요.~~	+	Please see http://www.stellarium.org/doc/head/codingStyle.html

	[[Category:Development]]		[[Category:Development]]

← Older revision		Revision as of 23:31, 15 September 2010
Line 1:		Line 1:
−	~~Please see~~ http://www.stellarium.org/doc/head/codingStyle.html	+	http://www.stellarium.org/doc/head/codingStyle.html 사이트를 참조하세요.

	[[Category:Development]]		[[Category:Development]]

← Older revision		Revision as of 13:53, 2 December 2008
Line 124:		Line 124:

	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.		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.
		+
		+	[[Category:Development]]

@@ Line 16: / Line 16: @@
   void MyClass::myMethod(int x)
+  {
-    if (x>10)
+         if (x>10)
-−
+         {
-       cout << "You won." << endl;
+                 cout << "You won." << endl;
-−
+         }
+  }
 *Use blank lines as follows:
@@ Line 26: / Line 26: @@
 **2 between sections of a source ﬁle
 *''enums'' should follow the QT conventions.  i.e. CamelCase with First letter capitalization for both enum type and enum values.  Document with doxygen.  The //!< tag can be used to add descriptions on the same line as an enum value, e.g.
-  //! @enum InfoStringGroup used as named bitfield flags as specifiers to
+  //! @enum EnumName Here is a description of the enum
- //! filter results of getInfoString. The precise definition of these should
- //! be documented in the getInfoString documentation for the derived classes
- //! for all specifiers which are defined in that derivative.
   enum EnumName
+  {

@@ Line 25: / Line 25: @@
 **1 between logical sections of a method
 **2 between sections of a source ﬁle
 == File Names ==

@@ Line 89: / Line 89: @@
   text << q_("Distance: ") << distance << q_("AU");   // Bad
   text = q_("Distance: %1AU").arg(distance);          // Good
-* When using Qt format strings, if a letter follows a digit immediately, xgettext might erroneously mark the extracted string as a C format string. This might cause errors when compiling the binary message catalogs (depending on the actual translation). To prevent this, add an <tt>xgettext:no-c-format</tt> comment to the line preceding the format string:
+* When using Qt format strings, if a letter follows a digit immediately, xgettext might erroneously mark the extracted string as a C format string. ''Depending on the actual translation, this might cause errors when uploading the message catalog to Rosetta, or when compiling it to binary format.'' To prevent this, add an <tt>xgettext:no-c-format</tt> comment to the line preceding the format string:
   // xgettext:no-c-format
   text = q_("Distance: %1AU").arg(distance);

@@ Line 84: / Line 84: @@
 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.