(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | <languages /> | ||
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. | ||
− | '''In short: Kdelibs coding style follows the Qt 4 coding style.''' | + | '''In short: Kdelibs coding style follows the [http://wiki.qt-project.org/Coding_Style Qt 4 coding style].''' |
== Indentation == | == Indentation == | ||
Line 13: | Line 14: | ||
* 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 | |
Example: | Example: | ||
Line 26: | Line 27: | ||
QString errorString; | QString errorString; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
+ | |||
== Whitespace == | == Whitespace == | ||
Line 134: | Line 136: | ||
<syntaxhighlight lang="text"> | <syntaxhighlight lang="text"> | ||
astyle --indent=spaces=4 --brackets=linux \ | astyle --indent=spaces=4 --brackets=linux \ | ||
− | --indent-labels --pad | + | --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 '*.cpp'-or -name '*.cc' -or -name '*.h'` |
</syntaxhighlight> | </syntaxhighlight> | ||
Line 143: | Line 145: | ||
<syntaxhighlight lang="text"> | <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 --pad-header \ |
--keep-one-line-statements --convert-tabs \ | --keep-one-line-statements --convert-tabs \ | ||
--indent-preprocessor \ | --indent-preprocessor \ | ||
− | `find -type f -name '*.cpp' | + | `find -type f -name '*.cpp' -or -name '*.cc' -or -name '*.h'` |
</syntaxhighlight> | </syntaxhighlight> | ||
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.
Example:
// wrong
KProgressBar *prbar;
QString prtxt, errstr;
// correct
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;
Example:
// wrong
QString* myString;
if(true){
}
// correct
QString *myString;
if (true) {
}
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);
}
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;
}
Try to keep lines shorter than 100 characters, inserting line breaks as necessary.
Example:
// wrong
#include <QString>
// correct
#include <QtCore/QString>
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 --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'`
A related shell script could be found for unix in kdesdk/scripts/astyle-kdelibs and for windows in kdesdk/scripts/astyle-kdelibs.bat.
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 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.
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.