Policies/Kdelibs Coding Style/ru

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 coding style, with one main difference: using curly braces even when the body of a conditional statement contains only one line.

Отступы

• Не используем табуляцию
• Один отступ — 4 пробела

Объявление переменных

• Каждая переменная должна быть объявлена на отдельной строке,
• Каждое новое слово в имени переменной должно начинаться с заглавной буквы (так называемый стиль camelCase),
• Избегаем использования аббревиатур,
• Используем говорящие имена для переменных. Не используем слишком короткие имена, за исключением:
  • Однобуквенных имён переменных, которые используются как счётчики или временные переменные, когда назначение этих переменных очевидно,
• Имена переменных и функций начинаются со строчной буквы

Пример:

// неправильно
KProgressBar *prbar;
QString prtxt, errstr;

// правильно
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;

Пробельные символы

• Вставляйте пустые строки для группировки строк кода.
• Используйте только одну пустую строку в качестве разделителя.
• Вставляйте один пробел после каждого ключевого слова.
• Для указателей и ссылок добавляйте один пробел перед символом «*» или «&», но не после него.
• Не добавляйте пробелов после приведения типа в стиле языка C.

Пример:

// неправильно
QString* myString;
if(true){
}

// правильно
QString *myString;
if (true) {
}

Фигурные скобки

В большинстве случаев открывающая фигурная скобка пишется на той же строке, что и начало оператора.

Пример:

// неправильно
if (true)
{
}

// правильно
if (true) {
}

Исключения: в реализациях функций и определениях классов, структур и пространств имён открывающая фигурная скобка всегда находится на новой строке.

Пример:

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

class Debug
{
};

Используйте фигурные скобки даже если тело условного оператора состоит из одного оператора.

Пример:

// неправильно
if (true)
    return true;

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

// правильно
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

Пример:

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.

Пример:

// неправильно
#include <QString>

// правильно
#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'-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'`

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:

• kde-dev-scripts/astyle-kdelibs (POSIX)
• kde-dev-scripts/astyle-kdelibs.bat (Windows)

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