(Created page with "== Quebra de linha == Tente manter linhas menores que 100 caracteres, inserindo quebras de linha conforme for necessário.") |
(Created page with "== Qt Includes == * Se você adicionar #includes para as classes do Qt, use o nome do módulo e da classe. Isso permite que a biblioteca seja utilizada sem uso excessivo de parâ...") |
||
Line 120: | Line 120: | ||
== Qt Includes == | == Qt Includes == | ||
− | * | + | * Se você adicionar #includes para as classes do Qt, use o nome do módulo e da classe. Isso permite que a biblioteca seja utilizada sem uso excessivo de parâmetros para o compilador |
Example: | Example: |
Esse documento descreve o estilo de código recomendado para kdelibs. Ninguém é forçado a usá-lo, mas para ter uma formatação consistente dos seus arquivos de código-fonte é recomendado fazer uso dele.
Em síntese: O estilo de código da Kdelibs segue o estilo de código do Qt 4.
Exemplo:
// wrong
KProgressBar *prbar;
QString prtxt, errstr;
// certo
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;
Exemplo:
// errado
QString* myString;
if(true){
}
// certo
QString *myString;
if (true) {
}
Como uma regra básica, a abertura da chave fica na mesma linha do comando que inicia o bloco.
Exemplo:
// errado
if (true)
{
}
// certo
if (true) {
}
Exceção: A chave de abertura das implementações de função, declarações de classes, struct's e namespace's deve ser sempre colocada no início da linha seguinte.
Exemplo:
void debug(int i)
{
qDebug("foo: %i", i);
}
class Debug
{
};
Use as chaves mesmo quando o corpo de um bloco condicional contiver apenas uma linha.
Exemplo:
// errado
if (true)
return true;
for (int i = 0; i < 10; ++i)
qDebug("%i", i);
// certo
if (true) {
return true;
}
for (int i = 0; i < 10; ++i) {
qDebug("%i", i);
}
Case labels ficam na mesma coluna do switch
Exemplo:
switch (myEnum) {
case Value1:
doSomething();
break;
case Value2:
doSomethingElse();
// fall through
default:
defaultHandling();
break;
}
Tente manter linhas menores que 100 caracteres, inserindo quebras de linha conforme for necessário.
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.