Difference between revisions of "Policies/Kdelibs Coding Style"

Jump to: navigation, search
(Artistic Style (astyle) automatic code formatting)
(add translate tags)
Line 1: Line 1:
 +
<translate>
 
This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formatting of the source code files it is recommended to make use of it.
 
This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formatting of the source code files it is recommended to make use of it.
  
Line 16: Line 17:
  
 
Example:
 
Example:
 +
</translate>
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
// wrong
+
<translate>// wrong</translate>
 
KProgressBar *prbar;
 
KProgressBar *prbar;
 
QString prtxt, errstr;
 
QString prtxt, errstr;
  
// correct
+
<translate>// correct</translate>
 
KProgressBar *downloadProgressBar;
 
KProgressBar *downloadProgressBar;
 
QString progressText;
 
QString progressText;
Line 27: Line 29:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
== Whitespace ==
 
== Whitespace ==
 
* Use blank lines to group statements
 
* Use blank lines to group statements
Line 35: Line 38:
  
 
Example:
 
Example:
 +
</translate>
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
// wrong
+
<translate>// wrong</translate>
 
QString* myString;
 
QString* myString;
 
if(true){
 
if(true){
 
}
 
}
  
// correct
+
<translate>// correct</translate>
 
QString *myString;
 
QString *myString;
 
if (true) {
 
if (true) {
Line 47: Line 51:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
== Braces ==
 
== Braces ==
 
As a base rule, the left curly brace goes on the same line as the start of the statement.
 
As a base rule, the left curly brace goes on the same line as the start of the statement.
  
 
Example:
 
Example:
 +
</translate>
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
// wrong
+
<translate>// wrong</translate>
 
if (true)
 
if (true)
 
{
 
{
 
}
 
}
  
// correct
+
<translate>// correct</translate>
 
if (true) {
 
if (true) {
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
Exception: Function implementations, class, struct and namespace declarations always have the opening brace on the start of a line.
 
Exception: Function implementations, class, struct and namespace declarations always have the opening brace on the start of a line.
  
 
Example:
 
Example:
 +
</translate>
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
void debug(int i)
 
void debug(int i)
Line 76: Line 84:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
Use curly braces even when the body of a conditional statement contains only one line.
 
Use curly braces even when the body of a conditional statement contains only one line.
  
 
Example:
 
Example:
 +
</translate>
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
// wrong
+
<translate>// wrong</translate>
 
if (true)
 
if (true)
 
     return true;
 
     return true;
Line 87: Line 97:
 
     qDebug("%i", i);
 
     qDebug("%i", i);
  
// correct
+
<translate>// correct</translate>
 
if (true) {
 
if (true) {
 
     return true;
 
     return true;
Line 97: Line 107:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
== Switch statements ==
 
== Switch statements ==
 
Case labels are on the same column as the switch
 
Case labels are on the same column as the switch
  
 
Example:
 
Example:
 +
</translate>
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
switch (myEnum) {
 
switch (myEnum) {
Line 115: Line 127:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
== Line breaks ==
 
== Line breaks ==
 
Try to keep lines shorter than 100 characters, inserting line breaks as necessary.
 
Try to keep lines shorter than 100 characters, inserting line breaks as necessary.
Line 122: Line 135:
  
 
Example:
 
Example:
 +
</translate>
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
// wrong
+
<translate>// wrong</translate>
 
#include <QString>
 
#include <QString>
  
// right
+
<translate>// correct</translate>
 
#include <QtCore/QString>
 
#include <QtCore/QString>
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
== Artistic Style (astyle) automatic code formatting ==
 
== Artistic Style (astyle) automatic code formatting ==
 
You can use [http://astyle.sourceforge.net/ astyle] (>=1.23) to format code or to test if you have followed this document. Run the following command:
 
You can use [http://astyle.sourceforge.net/ astyle] (>=1.23) to format code or to test if you have followed this document. Run the following command:
 +
</translate>
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
astyle --indent=spaces=4 --brackets=linux \
 
astyle --indent=spaces=4 --brackets=linux \
Line 140: Line 156:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
With astyle (>=2.01) you need to run the following command:
 
With astyle (>=2.01) you need to run the following command:
 +
</translate>
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
astyle --indent=spaces=4 --brackets=linux \
 
astyle --indent=spaces=4 --brackets=linux \
Line 149: Line 167:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
A related shell script could be found for unix in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/astyle-kdelibs kdesdk/scripts/astyle-kdelibs] and for windows in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/astyle-kdelibs.bat kdesdk/scripts/astyle-kdelibs.bat].
 
A related shell script could be found for unix in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/astyle-kdelibs kdesdk/scripts/astyle-kdelibs] and for windows in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/astyle-kdelibs.bat kdesdk/scripts/astyle-kdelibs.bat].
  
Line 158: Line 177:
  
 
To start using kde-emacs, add the following to your .emacs:
 
To start using kde-emacs, add the following to your .emacs:
 +
</translate>
  
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
Line 164: Line 184:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
<translate>
 
Many settings can be changed by editing the "kde-emacs" group via <tt>M-x customize-group</tt>.
 
Many settings can be changed by editing the "kde-emacs" group via <tt>M-x customize-group</tt>.
  
Line 172: Line 193:
  
 
To use the script, include it in your {{path|~/.vimrc}} like this:
 
To use the script, include it in your {{path|~/.vimrc}} like this:
 +
</translate>
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
source /path/to/kde/sources/kdesdk/scripts/kde-devel-vim.vim
 
source /path/to/kde/sources/kdesdk/scripts/kde-devel-vim.vim
Line 177: Line 199:
  
  
 +
<translate>
 
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.
 
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.
  
 
[[Category:Policies]] [[Category:C++]]
 
[[Category:Policies]] [[Category:C++]]
 +
</translate>

Revision as of 11:35, 3 July 2011

This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formatting of the source code files it is recommended to make use of it.

In short: Kdelibs coding style follows the Qt 4 coding style.

Contents

Indentation

  • No tabs
  • 4 Spaces instead of one tab

Variable declaration

  • Each variable declaration on a new line
  • Each new word in a variable name starts with a capital letter (so-called camelCase)
  • Avoid abbreviations
  • Take useful names. No short names, except:
    • Single character variable names can denote counters and temporary variables whose purpose is obvious
    • Variables and functions start with a lowercase letter

Example:

// wrong
KProgressBar *prbar;
QString prtxt, errstr;
 
// correct
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;

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:

// wrong
QString* myString;
if(true){
}
 
// correct
QString *myString;
if (true) {
}

Braces

As a base rule, the left curly brace goes on the same line as the start of the statement.

Example:

// wrong
if (true)
{
}
 
// correct
if (true) {
}

Exception: Function implementations, class, struct and namespace declarations always have the opening brace on the start of a line.

Example:

void debug(int i)
{
    qDebug("foo: %i", i);
}
 
class Debug
{
};

Use curly braces even when the body of a conditional statement contains only one line.

Example:

// 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);
}

Switch statements

Case labels are on the same column as the switch

Example:

switch (myEnum) {
case Value1:
    doSomething();
    break;
case Value2:
    doSomethingElse();
    // fall through
default:
    defaultHandling();
    break;
}

Line breaks

Try to keep lines shorter than 100 characters, inserting line breaks as necessary.

Qt Includes

  • If you add #includes for Qt classes, use both the module and class name. This allows library code to be used by applications without excessive compiler include paths.

Example:

// wrong
#include <QString>
 
// correct
#include <QtCore/QString>

Artistic Style (astyle) automatic code formatting

You can use astyle (>=1.23) to format code or to test if you have followed this document. Run the following command:

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 '*.cc'` `find -type f -name '*.h'`

With astyle (>=2.01) you need to run the following command:

astyle --indent=spaces=4 --brackets=linux \
       --indent-labels --pad-oper --unpad-paren \
       --keep-one-line-statements --convert-tabs \
       --indent-preprocessor \
       `find -type f -name '*.cpp'` `find -type f -name '*.cc'` `find -type f -name '*.h'`

A related shell script could be found for unix in kdesdk/scripts/astyle-kdelibs and for windows in kdesdk/scripts/astyle-kdelibs.bat.

Emacs and Vim scripts

The "scripts" directory in the kdesdk module contains, among other useful things, some useful additions to the Emacs and Vim text editors that make it easier to edit KDE code with them.

Emacs

The kde-emacs directory contains a set of key bindings, macros and general useful code. It is compatible with both GNU Emacs and XEmacs.

To start using kde-emacs, add the following to your .emacs:

(add-to-list 'load-path "/path/to/kde-emacs")
(require 'kde-emacs)

Many settings can be changed by editing the "kde-emacs" group via M-x customize-group.

For more information, including what the key bindings are and what additional settings you could add to your .emacs, please check kde-emacs.el itself.

Vim

You can find a vim script in kdesdk/scripts/kde-devel-vim.vim that helps you to keep the coding style correct. In addition to defaulting to the kdelibs coding style it will automatically use the correct style for Solid and kdepim code. If you want to add rules for other projects feel free to add them in the SetCodingStyle function.

To use the script, include it in your ~/.vimrc like this:

source /path/to/kde/sources/kdesdk/scripts/kde-devel-vim.vim


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.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal