Official:Code guidelines and formatting conventions - Revision history

Klojum at 14:53, 11 February 2020

2020-02-11T14:53:30Z

← Older revision		Revision as of 14:53, 11 February 2020
Line 2:		Line 2:
	These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules. For historic reason the current code doesn't always follow these guidelines however any new code should certainly follow them.		These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules. For historic reason the current code doesn't always follow these guidelines however any new code should certainly follow them.

	These coding guidelines and formatting conventions are part of our Doxygen documentation which can be generated from code. For easy viewing we also made these guidelines available online https://~~codedocs~~.~~xyz~~/xbmc/xbmc/~~code_guidelines~~.~~html~~		These coding guidelines and formatting conventions are part of our Doxygen documentation which can be generated from code. For easy viewing we also made these guidelines available online at https://github.com/xbmc/xbmc/blob/master/docs/CODE_GUIDELINES.md .


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

2016-04-30T08:27:33Z

2016-02-01T13:56:58Z

Methods

← Older revision		Revision as of 13:56, 1 February 2016
Line 182:		Line 182:

	=== Methods ===		=== Methods ===
	We use CamelCase for method names and first letter should be upper case.		We use CamelCase for method names and first letter should always be upper case. Even if the methods are private or protected.
	<pre>		<pre>
	void MyDummyClass::DoSomething();		void MyDummyClass::DoSomething();

2015-11-09T23:52:38Z

Headers

← Older revision		Revision as of 23:52, 9 November 2015
Line 22:		Line 22:

	=== Headers ===		=== Headers ===
	Included ~~source~~ files .cpp and .h, are to sort alphabetical to prevent double used file definition and allow better overview		Included header files *.h, are to sort alphabetical to prevent double used file definition and allow better overview
	* On cpp define used header first to confirm needed headers are present on them itself		* On cpp define used header first to confirm needed headers are present on them itself
	* As next use the global system headers e.g. <cassert> or "system.h"		* As next use the global system headers e.g. <cassert> or "system.h"

2015-11-09T23:49:11Z

Add guideline for included source code headers

@@ Line 19: / Line 19: @@
+}
+}
 </pre>

2015-06-22T07:23:11Z

Protected "Official:Code guidelines and formatting conventions" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))

← Older revision	Revision as of 07:23, 22 June 2015
(No difference)

2015-06-21T19:11:11Z

@@ Line 5: / Line 5: @@
 == Indentation ==
 Use spaces as tab policy with an indentation size of 2
 == Braces ==
@@ Line 91: / Line 106: @@
 == Naming ==
 === Constants ===
 Use upper case with underscore spacing where necessary.
@@ Line 107: / Line 130: @@
 </pre>
-=== Classes/Methods ===
+=== Interfaces ===
-We use CamelCase for class names and methods both with first letter in upper case.
+We use CamelCase for interface names and they should be prefixed with an uppercase I.
 <pre>
 void MyDummyClass::DoSomething();
 </pre>
@@ Line 129: / Line 171: @@
 </pre>
 [[Category:Development]]

2015-03-24T11:49:51Z

← Older revision	Revision as of 11:49, 24 March 2015
(No difference)

2015-03-24T11:49:37Z

← Older revision	Revision as of 11:49, 24 March 2015
(No difference)

2015-03-24T11:20:10Z

Variables

← Older revision		Revision as of 11:20, 24 March 2015
Line 115:		Line 115:

	=== Variables ===		=== Variables ===
	We use CamelCase for variables ~~and type~~ prefixing is optional.		We use CamelCase for variables. Type prefixing is optional.

	==== Global Variables ====		==== Global Variables ====