Перевод "Policies/Kdelibs Coding Style"

Urs Wolfer, Zack Rusin, “Policies/Kdelibs Coding Style”, public translation into Russian from English More about this translation.

See also 6 similar translations

Translate into another language.

Participants

Statistics
Participants
Translate into Russian
Translation result
Translation is not started yet.

Join Translated.by to translate! If you already have a Translated.by account, please sign in.
If you do not want to register an account, you can sign in with OpenID.

Policies/Kdelibs Coding Style
This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formating of the source code files it is recommended to make use of it.
In short: Kdelibs coding style follows the Qt 4 coding style. Contents
[hide]
1 Indentation
2 Variable declaration
3 Whitespace
4 Braces
5 Switch statements
6 Line breaks
7 Artistic Style (astyle) automatic code formatting
8 Vim script
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
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:
// wrong
KProgressBar *prbar;
QString prtxt, errstr;
// correct
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;
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:
// wrong
QString* myString;
if(true){
}
// correct
QString *myString;
if (true) {
}
Braces
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);
}
Switch statements
Case labels are on the same column as the switch
Example:
switch (myEnum) {
case Value1:
doSomething();