Difference between revisions of "Policies/Kdelibs Coding Style/ru"

Jump to: navigation, search
(Created page with "// неправильно")
(Created page with "Используйте фигурные скобки даже если тело условного оператора состоит из одного оператора.")
 
(24 intermediate revisions by 2 users 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.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.'''
  
 
== Отступы ==
 
== Отступы ==
Line 7: Line 8:
 
* Один отступ — 4 пробела
 
* Один отступ — 4 пробела
  
== Variable declaration ==
+
== Объявление переменных ==
* Each variable declaration on a new line
+
* Каждая переменная должна быть объявлена на отдельной строке,
* Each new word in a variable name starts with a capital letter (so-called camelCase)
+
* Каждое новое слово в имени переменной должно начинаться с заглавной буквы (так называемый стиль 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:
+
Пример:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
// неправильно
 
// неправильно
Line 21: Line 22:
 
QString prtxt, errstr;
 
QString prtxt, errstr;
  
// correct
+
// правильно
 
KProgressBar *downloadProgressBar;
 
KProgressBar *downloadProgressBar;
 
QString progressText;
 
QString progressText;
Line 27: Line 28:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== 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:
+
== Пробельные символы ==
 +
* Вставляйте пустые строки для группировки строк кода.
 +
* Используйте только одну пустую строку в качестве разделителя.
 +
* Вставляйте один пробел после каждого ключевого слова.
 +
* Для указателей и ссылок добавляйте один пробел перед символом «*» или «&», но не после него.
 +
* Не добавляйте пробелов после приведения типа в стиле языка C.
 +
 
 +
Пример:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
// неправильно
 
// неправильно
Line 41: Line 43:
 
}
 
}
  
// correct
+
// правильно
 
QString *myString;
 
QString *myString;
 
if (true) {
 
if (true) {
Line 47: Line 49:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== Braces ==
+
== Фигурные скобки ==
As a base rule, the left curly brace goes on the same line as the start of the statement.
+
В большинстве случаев открывающая фигурная скобка пишется на той же строке, что и начало оператора.
  
Example:
+
Пример:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
// неправильно
 
// неправильно
Line 57: Line 59:
 
}
 
}
  
// correct
+
// правильно
 
if (true) {
 
if (true) {
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Exception: Function implementations, class, struct and namespace declarations always have the opening brace on the start of a line.
+
Исключения: в реализациях функций и определениях классов, структур и пространств имён открывающая фигурная скобка всегда находится на новой строке.
  
Example:
+
Пример:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
void debug(int i)
 
void debug(int i)
Line 76: Line 78:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Use curly braces even when the body of a conditional statement contains only one line.
+
Используйте фигурные скобки даже если тело условного оператора состоит из одного оператора.
  
Example:
+
Пример:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
// wrong
+
// неправильно
 
if (true)
 
if (true)
 
     return true;
 
     return true;
Line 87: Line 89:
 
     qDebug("%i", i);
 
     qDebug("%i", i);
  
// correct
+
// правильно
 
if (true) {
 
if (true) {
 
     return true;
 
     return true;
Line 100: Line 102:
 
Case labels are on the same column as the switch
 
Case labels are on the same column as the switch
  
Example:
+
Пример:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
switch (myEnum) {
 
switch (myEnum) {
Line 121: Line 123:
 
* 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 both the module and class name.  This allows library code to be used by applications without excessive compiler include paths.
  
Example:
+
Пример:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
// wrong
+
// неправильно
 
#include <QString>
 
#include <QString>
  
// correct
+
// правильно
 
#include <QtCore/QString>
 
#include <QtCore/QString>
 
</syntaxhighlight>
 
</syntaxhighlight>
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-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 '*.cc'` `find -type f -name '*.h'`
+
       `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 '*.cc'` `find -type f -name '*.h'`
+
       `find -type f -name '*.cpp' -or -name '*.cc' -or -name '*.h'`
 
</syntaxhighlight>
 
</syntaxhighlight>
  
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.
 +
 
 +
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 ==
 
== Emacs and Vim scripts ==
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.
  
 
To start using kde-emacs, add the following to your .emacs:
 
To start using kde-emacs, add the following to your .emacs:
Line 169: Line 176:
  
 
=== Vim ===
 
=== Vim ===
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 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 {{path|~/.vimrc}} like this:
 
To use the script, include it in your {{path|~/.vimrc}} like this:

Latest revision as of 13:57, 5 March 2016

Other languages:
čeština • ‎English • ‎suomi • ‎português do Brasil • ‎русский • ‎中文(中国大陆)‎

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:

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.


This page was last modified on 5 March 2016, at 13:57. Content is available under Creative Commons License SA 4.0 unless otherwise noted.