Policies/Frameworks Coding Style: Difference between revisions

From KDE Community Wiki
m (Put notes at the top in a {{Note}})
(15 intermediate revisions by 12 users not shown)
Line 1: Line 1:
<languages />
<languages />
<translate>
<translate>
<!--T:1-->
 
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.
{{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.
 


<!--T:2-->
<!--T:2-->
'''In short: Kdelibs coding style follows the [http://wiki.qt-project.org/Coding_Style Qt 4 coding style].'''
'''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-->
== Indentation == <!--T:3-->
Line 17: Line 19:
* Take useful names. No short names, except:
* Take useful names. No short names, except:
** Single character variable names can denote counters and temporary variables whose purpose is obvious
** Single character variable names can denote counters and temporary variables whose purpose is obvious
** Variables and functions start with a lowercase letter
* Variables and functions start with a lowercase letter


<!--T:5-->
<!--T:5-->
Line 36: Line 38:


<translate>
<translate>
== Whitespace == <!--T:8-->
== Whitespace == <!--T:8-->
* Use blank lines to group statements
* Use blank lines to group statements
Line 151: Line 154:


== Qt Includes == <!--T:25-->
== Qt Includes == <!--T:25-->
* 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.
* If you add #includes for Qt classes, use only the class name.


<!--T:26-->
<!--T:26-->
Line 159: Line 162:
<translate><!--T:27-->
<translate><!--T:27-->
// wrong</translate>
// wrong</translate>
#include <QString>
#include <QtCore/QString>


<translate><!--T:28-->
<translate><!--T:28-->
// correct</translate>
// correct</translate>
#include <QtCore/QString>
#include <QString>
</syntaxhighlight>
</syntaxhighlight>


<translate>
<translate>
== Artistic Style (astyle) automatic code formatting == <!--T:29-->
== 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:
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:
Line 183: Line 187:
</translate>
</translate>
<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
astyle --indent=spaces=4 --brackets=linux \
astyle --indent=spaces=4 --style=linux \
       --indent-labels --pad-oper --unpad-paren --pad-header \
       --indent-labels --pad-oper --unpad-paren --pad-header \
       --keep-one-line-statements --convert-tabs \
       --keep-one-line-statements --convert-tabs \
Line 192: Line 196:
<translate>
<translate>
<!--T:31-->
<!--T:31-->
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].
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-->
== Emacs and Vim scripts == <!--T:32-->
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.
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 ===
=== Emacs ===
The [http://websvn.kde.org/trunk/KDE/kdesdk/scripts/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.
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-->
<!--T:33-->
Line 217: Line 228:


=== Vim === <!--T:36-->
=== Vim === <!--T:36-->
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.
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.


<!--T:37-->
<!--T:37-->

Revision as of 09:57, 31 October 2019

<languages /> <translate>

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 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: </translate>

<translate><!--T:6-->
// wrong</translate>
KProgressBar *prbar;
QString prtxt, errstr;

<translate><!--T:7-->
// correct</translate>
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;

<translate>

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: </translate>

<translate><!--T:10-->
// wrong</translate>
QString* myString;
if(true){
}

<translate><!--T:11-->
// correct</translate>
QString *myString;
if (true) {
}

<translate>

Braces

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

Example: </translate>

<translate><!--T:14-->
// wrong</translate>
if (true)
{
}

<translate><!--T:15-->
// correct</translate>
if (true) {
}

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

Example: </translate>

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

class Debug
{
};

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

Example: </translate>

<translate><!--T:20-->
// wrong</translate>
if (true)
    return true;

for (int i = 0; i < 10; ++i)
    qDebug("%i", i);

<translate><!--T:21-->
// correct</translate>
if (true) {
    return true;
}

for (int i = 0; i < 10; ++i) {
    qDebug("%i", i);
}

<translate>

Switch statements

Case labels are on the same column as the switch

Example: </translate>

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

<translate>

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: </translate>

<translate><!--T:27-->
// wrong</translate>
#include <QtCore/QString>

<translate><!--T:28-->
// correct</translate>
#include <QString>

<translate>

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: </translate>

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'`

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

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'`

<translate> 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: </translate>

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

<translate> 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: </translate>

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


<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. </translate>