Policies/Frameworks Coding Style: Difference between revisions

From KDE Community Wiki
m (typo)
m (Remove old translation info)
(48 intermediate revisions by 31 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 make use of it.


'''In short: Kdelibs coding style follows the Qt 4 coding style.'''
{{Note|1=<!--T:1-->
This document describes the recommended coding style for KDE Frameworks. 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.


== Indentation ==
 
<!--T:2-->
'''In short: KDE Frameworks coding style follows the [http://wiki.qt.io/Qt_Coding_Style Qt coding style], with one main difference: using curly braces even when the body of a conditional statement contains only one line.'''}}
 
== Indentation == <!--T:3-->
* No tabs
* No tabs
* 4 Spaces instead of one tab
* 4 Spaces instead of one tab


== Variable declaration ==
== Variable declaration == <!--T:4-->
* Each variable declaration on a new line
* Each variable should be declared on a new line
* Take useful names, no short names, except:
* Each new word in a variable name starts with a capital letter (so-called camelCase)
* 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
* Avoid abbreviations
* Use indicative/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
* Member variable names should be prefixed with '''m_''' to make it easier to distinguish them from function parameters and local variable names
** The same applies to Private (d-pointer) class member variable names,  (it may be a bit overkill when the Private class is merely used as a struct and all the code is in the public class, so you can use the '''m_''' prefix everywhere to keep it consistent, or switch to prefixing '''m_''' when adding the first ''method'' to a Private class)
* Static (global) variable names should be prefixed with '''s_'''


<!--T:5-->
Example:
Example:
<code cppqt>
<syntaxhighlight lang="cpp-qt">
// wrong
// wrong
KProgressBar *prbar;
KProgressBar *prbar;
Line 25: Line 33:
QString progressText;
QString progressText;
QString errorString;
QString errorString;
</code>
</syntaxhighlight>


== Whitespace ==
== Whitespace == <!--T:8-->
* Use blank lines to group statements
* Use blank lines to group statements
* Use only one empty line
* Use only one empty line
Line 34: Line 42:
* No space after a cast
* No space after a cast


<!--T:9-->
Example:
Example:
<code cppqt>
 
<syntaxhighlight lang="cpp-qt">
 
// wrong
// wrong
QString* myString;
QString* myString;
Line 45: Line 56:
if (true) {
if (true) {
}
}
</code>
</syntaxhighlight>


== Braces ==
== Braces == <!--T:12-->
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.


<!--T:13-->
Example:
Example:
<code cppqt>
 
<syntaxhighlight lang="cpp-qt">
 
// wrong
// wrong
if (true)
if (true)
Line 60: Line 74:
if (true) {
if (true) {
}
}
</code>
</syntaxhighlight>
 


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:
<code cppqt>
 
<syntaxhighlight lang="cpp-qt">
void debug(int i)
void debug(int i)
{
{
Line 74: Line 90:
{
{
};
};
</code>
</syntaxhighlight>


<!--T:18-->
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.


<!--T:19-->
Example:
Example:
<code cppqt>
 
<syntaxhighlight lang="cpp-qt">
 
// wrong
// wrong
if (true)
if (true)
Line 86: Line 107:
for (int i = 0; i < 10; ++i)
for (int i = 0; i < 10; ++i)
     qDebug("%i", i);
     qDebug("%i", i);


// correct
// correct
Line 95: Line 117:
     qDebug("%i", i);
     qDebug("%i", i);
}
}
</code>
</syntaxhighlight>


== Switch statements ==
 
== Switch statements == <!--T:22-->
Case labels are on the same column as the switch
Case labels are on the same column as the switch


<!--T:23-->
Example:
Example:
<code cppqt>
 
<syntaxhighlight lang="cpp-qt">
switch (myEnum) {
switch (myEnum) {
case Value1:
case Value1:
Line 113: Line 138:
     break;
     break;
}
}
</code>
</syntaxhighlight>
 


== Artistic Style (astyle) automatic code formatting ==
== Line breaks == <!--T:24-->
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:
Try to keep lines shorter than 100 characters, inserting line breaks as necessary.
<code>
 
== Qt Includes == <!--T:25-->
* If you add #includes for Qt classes, use only the  class name.
 
<!--T:26-->
Example:
 
<syntaxhighlight lang="cpp-qt">
 
// wrong
#include <QtCore/QString>
 
 
// correct
#include <QString>
</syntaxhighlight>
 
 
== Artistic Style (astyle) automatic code formatting == <!--T:29-->
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:
 
<syntaxhighlight lang="text">
astyle --indent=spaces=4 --brackets=linux \
astyle --indent=spaces=4 --brackets=linux \
       --indent-labels --pad=oper --unpad=paren \
       --indent-labels --pad=oper --unpad=paren \
       --one-line=keep-statements --convert-tabs \
       --one-line=keep-statements --convert-tabs \
       --indent-preprocessor \
       --indent-preprocessor \
       `find -type f -name '*.cpp'` `find -type f -name '*.h'`
       `find -type f -name '*.cpp'-or -name '*.cc' -or -name '*.h'`
</code>
</syntaxhighlight>


== Vim script ==
 
You can find a vim script in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/kde-devel-vim.vim 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.
<!--T:30-->
With astyle (>=2.01) you need to run the following command:
 
<syntaxhighlight lang="text">
astyle --indent=spaces=4 --style=linux \
      --indent-labels --pad-oper --unpad-paren --pad-header \
      --keep-one-line-statements --convert-tabs \
      --indent-preprocessor \
      `find -type f -name '*.cpp' -or -name '*.cc' -or -name '*.h'`
</syntaxhighlight>
 
 
<!--T:31-->
Note: With more recent astyle --brackets has become --style, so change --brackets=linux to --style=linux.
 
<!--T:41-->
You can find a shell script to run this command in:
 
<!--T:40-->
* [https://commits.kde.org/kde-dev-scripts?path=astyle-kdelibs kde-dev-scripts/astyle-kdelibs] (POSIX)
* [https://commits.kde.org/kde-dev-scripts?path=astyle-kdelibs.bat kde-dev-scripts/astyle-kdelibs.bat] (Windows)
 
== Emacs and Vim scripts == <!--T:32-->
The [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/show kde-dev-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 [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/show/kde-emacs kde-emacs] directory contains a set of key bindings, macros and general useful code. It is compatible with both GNU Emacs and XEmacs.
 
<!--T:33-->
To start using kde-emacs, add the following to your .emacs:
 
 
<syntaxhighlight lang="text">
(add-to-list 'load-path "/path/to/kde-emacs")
(require 'kde-emacs)
</syntaxhighlight>
 
Many settings can be changed by editing the "kde-emacs" group via <tt>M-x customize-group</tt>.
 
For more information, including what the key bindings are and what additional settings you could add to your .emacs, please check <tt>kde-emacs.el</tt> itself.
 
=== Vim ===
You can find a vim script in [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/raw/kde-devel-vim.vim kde-devel-vim.vim] that helps you to keep the coding style correct. In addition to defaulting to the KDE Frameworks 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 {{path|~/.vimrc}} like this:
To use the script, include it in your {{path|~/.vimrc}} like this:
<code>
 
<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
</code>
</syntaxhighlight>
 


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++]]

Revision as of 16:49, 15 January 2021

Note

This document describes the recommended coding style for KDE Frameworks. 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: KDE Frameworks coding style follows the Qt coding style, with one main difference: using curly braces even when the body of a conditional statement contains only one line.


Indentation

  • No tabs
  • 4 Spaces instead of one tab

Variable declaration

  • Each variable should be declared on a new line
  • Each new word in a variable name starts with a capital letter (so-called camelCase)
  • Avoid abbreviations
  • Use indicative/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
  • Member variable names should be prefixed with m_ to make it easier to distinguish them from function parameters and local variable names
    • The same applies to Private (d-pointer) class member variable names, (it may be a bit overkill when the Private class is merely used as a struct and all the code is in the public class, so you can use the m_ prefix everywhere to keep it consistent, or switch to prefixing m_ when adding the first method to a Private class)
  • Static (global) variable names should be prefixed with s_

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 only the class name.

Example:

// wrong
#include <QtCore/QString>


// correct
#include <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'-or -name '*.cc' -or -name '*.h'`


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

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


Note: With more recent astyle --brackets has become --style, so change --brackets=linux to --style=linux.

You can find a shell script to run this command in:

Emacs and Vim scripts

The kde-dev-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 kde-devel-vim.vim that helps you to keep the coding style correct. In addition to defaulting to the KDE Frameworks 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.