Difference between revisions of "Policies/Kdelibs Coding Style"

Jump to: navigation, search
(Fixed the links to the astyle-kdelibs script, now hosted in git.)
(Replaced content with "{{Moved To Community}}")
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages />
+
{{Moved To Community}}
<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.
+
 
+
<!--T:2-->
+
'''In short: Kdelibs coding style follows the [http://wiki.qt-project.org/Coding_Style Qt 4 coding style].'''
+
 
+
== Indentation == <!--T:3-->
+
* No tabs
+
* 4 Spaces instead of one tab
+
 
+
== Variable declaration == <!--T:4-->
+
* 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
+
 
+
<!--T:5-->
+
Example:
+
</translate>
+
<syntaxhighlight lang="cpp-qt">
+
<translate><!--T:6-->
+
// wrong</translate>
+
KProgressBar *prbar;
+
QString prtxt, errstr;
+
 
+
<translate><!--T:7-->
+
// correct</translate>
+
KProgressBar *downloadProgressBar;
+
QString progressText;
+
QString errorString;
+
</syntaxhighlight>
+
 
+
<translate>
+
 
+
== Whitespace == <!--T:8-->
+
* 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
+
 
+
<!--T:9-->
+
Example:
+
</translate>
+
<syntaxhighlight lang="cpp-qt">
+
<translate><!--T:10-->
+
// wrong</translate>
+
QString* myString;
+
if(true){
+
}
+
 
+
<translate><!--T:11-->
+
// correct</translate>
+
QString *myString;
+
if (true) {
+
}
+
</syntaxhighlight>
+
 
+
<translate>
+
== Braces == <!--T:12-->
+
As a base rule, the left curly brace goes on the same line as the start of the statement.
+
 
+
<!--T:13-->
+
Example:
+
</translate>
+
<syntaxhighlight lang="cpp-qt">
+
<translate><!--T:14-->
+
// wrong</translate>
+
if (true)
+
{
+
}
+
 
+
<translate><!--T:15-->
+
// correct</translate>
+
if (true) {
+
}
+
</syntaxhighlight>
+
 
+
<translate>
+
<!--T:16-->
+
Exception: Function implementations, class, struct and namespace declarations always have the opening brace on the start of a line.
+
 
+
<!--T:17-->
+
Example:
+
</translate>
+
<syntaxhighlight lang="cpp-qt">
+
void debug(int i)
+
{
+
    qDebug("foo: %i", i);
+
}
+
 
+
class Debug
+
{
+
};
+
</syntaxhighlight>
+
 
+
<translate>
+
<!--T:18-->
+
Use curly braces even when the body of a conditional statement contains only one line.
+
 
+
<!--T:19-->
+
Example:
+
</translate>
+
<syntaxhighlight lang="cpp-qt">
+
<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);
+
}
+
</syntaxhighlight>
+
 
+
<translate>
+
== Switch statements == <!--T:22-->
+
Case labels are on the same column as the switch
+
 
+
<!--T:23-->
+
Example:
+
</translate>
+
<syntaxhighlight lang="cpp-qt">
+
switch (myEnum) {
+
case Value1:
+
    doSomething();
+
    break;
+
case Value2:
+
    doSomethingElse();
+
    // fall through
+
default:
+
    defaultHandling();
+
    break;
+
}
+
</syntaxhighlight>
+
 
+
<translate>
+
== Line breaks == <!--T:24-->
+
Try to keep lines shorter than 100 characters, inserting line breaks as necessary.
+
 
+
== 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.
+
 
+
<!--T:26-->
+
Example:
+
</translate>
+
<syntaxhighlight lang="cpp-qt">
+
<translate><!--T:27-->
+
// wrong</translate>
+
#include <QString>
+
 
+
<translate><!--T:28-->
+
// correct</translate>
+
#include <QtCore/QString>
+
</syntaxhighlight>
+
 
+
<translate>
+
== 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:
+
</translate>
+
<syntaxhighlight lang="text">
+
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'`
+
</syntaxhighlight>
+
 
+
<translate>
+
<!--T:30-->
+
With astyle (>=2.01) you need to run the following command:
+
</translate>
+
<syntaxhighlight lang="text">
+
astyle --indent=spaces=4 --brackets=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>
+
 
+
<translate>
+
<!--T:31-->
+
You can find a shell script to run this command in:
+
 
+
* [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/raw/astyle-kdelibs kde-dev-scripts/astyle-kdelibs] (POSIX)
+
* [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/raw/astyle-kdelibs.bat kde-dev-scripts/astyle-kdelibs.bat] (Windows)
+
 
+
== 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.
+
+
=== 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.
+
 
+
<!--T:33-->
+
To start using kde-emacs, add the following to your .emacs:
+
</translate>
+
 
+
<syntaxhighlight lang="text">
+
(add-to-list 'load-path "/path/to/kde-emacs")
+
(require 'kde-emacs)
+
</syntaxhighlight>
+
 
+
<translate>
+
<!--T:34-->
+
Many settings can be changed by editing the "kde-emacs" group via <tt>M-x customize-group</tt>.
+
 
+
<!--T:35-->
+
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 === <!--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.
+
 
+
<!--T:37-->
+
To use the script, include it in your {{path|~/.vimrc}} like this:
+
</translate>
+
<syntaxhighlight lang="text">
+
source /path/to/kde/sources/kdesdk/scripts/kde-devel-vim.vim
+
</syntaxhighlight>
+
 
+
 
+
<translate>
+
<!--T:38-->
+
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.
+
 
+
<!--T:39-->
+
[[Category:Policies]] [[Category:C++]]
+
</translate>
+

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 3.0 as well as the GNU Free Documentation License 1.2 unless otherwise noted.