Difference between revisions of "Policies/Kdelibs Coding Style"

Jump to: navigation, search
(initial document)
 
(Replaced content with "{{Moved To Community}}")
 
(43 intermediate revisions by 30 users not shown)
Line 1: Line 1:
This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formating of the source code files it is recommended to take use of it.
+
{{Moved To Community}}
 
+
'''In short: Kdelibs coding style follows the Qt 4 coding style.'''
+
 
+
== Indentation ==
+
* No tabs
+
* 4 Spaces instead of one tab
+
 
+
== Variable delclaration ==
+
* Each variable declaration on a new line
+
* Take useful names, no short names, except:
+
* Single character variable names can be used for counters and temporary variables, where the purpose is obvious
+
* Variables and functions start with a small letter
+
* Each new word in a variable name starts with a capital letter
+
* Avoid abbreviations
+
 
+
Example:
+
<code cppqt>
+
// wrong
+
KProgressBar *prbar;
+
QString prtxt, errstr;
+
 
+
// correct
+
KProgressBar *downloadProgressBar;
+
QString progressText;
+
QString errorString;
+
</code>
+
 
+
== Whitespace ==
+
* Use blank lines to group statements
+
* Use only one empty line
+
* Use one space after each keyword
+
* For pointers or references, use a single space before '*' or '&', but not after
+
* No space after a cast
+
 
+
Example:
+
<code cppqt>
+
// wrong
+
QString* myString;
+
if(true){
+
}
+
 
+
// correct
+
QString *myString;
+
if (true) {
+
}
+
</code>
+
 
+
== Braces ==
+
As a base rule, the left curly brace goes on the same line as the start of the statement.
+
 
+
Example:
+
<code cppqt>
+
// wrong
+
if (true)
+
{
+
}
+
 
+
// correct
+
if (true) {
+
}
+
</code>
+
 
+
Exception: Function implementations and class declarations always have the left brace on the start of a line.
+
 
+
Example:
+
<code cppqt>
+
void debug(int i)
+
{
+
    qDebug("foo: %i", i);
+
}
+
 
+
class Debug
+
{
+
};
+
</code>
+
 
+
Use curly braces when the body of a conditional statement contains more than one line, and also if a single line statement is somewhat complex.
+
 
+
Example:
+
<code cppqt>
+
// wrong
+
if (true) {
+
    return true;
+
}
+
 
+
for (int i = 0; i < 10; ++i) {
+
    qDebug("%i", i);
+
}
+
 
+
// correct
+
if (true)
+
    return true;
+
 
+
for (int i = 0; i < 10; ++i)
+
    qDebug("%i", i);
+
</code>
+
 
+
Exception 1: Use braces also if the parent statement covers several lines or wraps.
+
 
+
Example:
+
<code cppqt>
+
if (address.isEmpty() || !isValid()
+
    || !codec) {
+
    return false;
+
}
+
</code>
+
 
+
Exception 2: Use braces also in if-then-else blocks where either the if-code or the else-code covers several lines.
+
 
+
Example:
+
<code cppqt>
+
// wrong
+
if (true)
+
    return true;
+
else {
+
    ++it;
+
    return false;
+
}
+
 
+
// correct
+
if (true) {
+
    return true;
+
} else {
+
    ++it;
+
    return false;
+
}
+
</code>
+
 
+
== Switch statements ==
+
Case labels are on the same column as the switch
+
 
+
Example:
+
<code cppqt>
+
switch (myEnum) {
+
case Value1:
+
    doSomething();
+
    break;
+
case Value2:
+
    doSomethingElse();
+
    // fall through
+
default:
+
    defaultHandling();
+
    break;
+
}
+
</code>
+
 
+
== Artistic Style (astyle) automatic code formatting ==
+
You can use [http://astyle.sourceforge.net/ astyle] (<=1.19) to format code or to test if you have followed this document. Run the following command:
+
<code>
+
astyle --indent=spaces=4 --brackets=linux --indent-labels --pad=oper --unpad=paren --one-line=keep-statements --convert-tabs --indent-preprocessor
+
`find -type f -name '*.cpp'` `find -type f -name '*.h'`
+
</code>
+
 
+
 
+
Document started by Urs Wolfer. Some parts of this document have been adopted from the Qt Coding Style document posted by Zack Rusin on kde-core-devel.
+

Latest revision as of 18:16, 10 March 2016

This page is now on the community wiki.


This page was last modified on 10 March 2016, at 18:16. Content is available under Creative Commons License SA 4.0 unless otherwise noted.