Qt Coding Style/es

Spanish English Русский 日本語
[toc align_right="yes" depth="2"]

Guia de estilo de código Qt

Este es un resumen de las practicas de codificación que usamos al escribir el código de Qt.

Los datos han sido recogidos de diferentes fuentes relacionas con Qt, foros de discusión, discusiones de correo electrónico y mediante la colaboración de los desarrolladores.

Sangrado (Indentación)

• Usar 4 espacios para sangrar
• Espacios, no tabulaciones!

Declarando variables

• Declarar cada variable en una linea separada
• Evitar nombres cortos siempre que sea posible (ej. "a", "rbarr", "nughdeget")
• Se recomiendan nombres de variables de un solo caracter solamente para usar en contadores y dónde el propósito de la variable es obvio.
• Esperar hasta que sea necesario para declarar una variable

<br /> // Incorrecto<br /> int a, b;<br /> char *c, *d;

// Correcto<br /> int height;<br /> int width;<br /> char *nameOfThis;<br /> char '''nameOfThat;<br />

El nombre de las variables y las funciones comienza con una letra minúsculas. Las siguientes palabras en el nombre de la variable empiezan con una letra mayúscula.

• Evitar la abreviaturas

<br /> // Incorrecto<br /> short Cntr;<br /> char ITEM_DELIM = '';

// Correcto<br /> short counter;<br /> char itemDelimiter = '';<br />

• Los nombres de las Clases siempre comienzan con una letra mayuscular. Clases publicas comienzan con una 'Q' (QRgb). Las funciones publicas a menudo comienzan con una 'q' (qRgb).

Espacios en blanco

• Usar lineas en blanco para agrupar declaraciones
• Siempre usar una linea en blanco
• Siempre usar un espacio en blanco despues de un carácter, y antes de un corchete

<br /> // Incorrecto<br /> if(foo){<br /> }

// Correcto<br /> if (foo) {<br /> }<br />

• Para punteros o referencias, siempre usar un espacio en blanco entre el o '&', pero no usarlos entre o '&' y el nombre de la variable

<br /> char '''x;<br /> const QString &amp;myString;<br /> const char''' const y = &quot;hello&amp;quot;;<br />

• Envuelva los operadores binarios con espacios
• Ningún espacio después de un "cast"
• Evitar los "cast" como en C, en la medida de lo posible

<br /> // Incorrecto<br /> char* blockOfMemory = (char* ) malloc(data.size());

// Correcto<br /> char '''blockOfMemory = reinterpret_cast&amp;lt;char'''&gt;(malloc(data.size()));<br />

Llaves

• Como regla básica, el corchete izquierdo debe estar en la misma linea de inicio de la declaración:

<br /> // Incorrecto<br /> if (codec)<br /> {<br /> }

// Correcto<br /> if (codec) {<br /> }<br />

• Las implementaciones de funciones y las declaraciones de clase siempre tendrán el corchete izquierdo en una nueva línea:

<br /> static void foo(int g)<br /> {<br /> qDebug(&quot;foo: %i&amp;quot;, g);<br /> }

class Moo<br /> {<br /> };<br />

• Usar llaves cuando el cuerpo de una declaración condicional contenga mas de una linea, y también si una declaración de una simple linea es algo compleja.

<br /> // Incorrecto<br /> if (address.isEmpty()) {<br /> return false;<br /> }

for (int i = 0; i &lt; 10; +''i) {<br /> qDebug(&quot;%i&amp;quot;, i);<br /> }
<br /> // Correcto<br /> if (address.isEmpty())<br /> return false;
<br /> for (int i = 0; i &lt; 10;i)<br /> qDebug(&quot;%i&amp;quot;, i);<br />

* Excepción 1: Use llaves a si la declaración padre abarca muchas lineas

<br /> // Correcto<br /> if (address.isEmpty() || !isValid()<br /> || !codec) {<br /> return false;<br /> }<br />

* Excepción 2: Use llaves también en bloques if-then-else, donde el código 'if' o el código 'else' ocupen varias lineas.

<br /> // Incorrecto<br /> if (address.isEmpty())<br /> return false;<br /> else {<br /> qDebug(&quot;%s&amp;quot;, qPrintable(address));<br />it;<br /> }
<br /> // Correcto<br /> if (address.isEmpty()) {<br /> return false;<br /> } else {<br /> qDebug(&quot;%s&amp;quot;, qPrintable(address));<br />it;<br /> }
<br /> // Incorrecto<br /> if (a)<br /> if (b)<br /> …<br /> else<br /> …
<br /> // Correcto<br /> if (a) {<br /> if (b)<br /> …<br /> else<br /> …<br /> }<br />

* Use llaves cuando el cuerpo de una sentencia condicional este vacía

<br /> // Incorrecto<br /> while (a);
<br /> // Correcto<br /> while (a) {}<br />

h2. Paréntesis
* Use paréntesis para agrupar expresiones:

<br /> // Incorrecto<br /> if (a &amp;&amp; b || c)
<br /> // Correcto<br /> if ((a &amp;&amp; b) || c)
<br /> // Incorrecto<br /> a'' b &amp; c

// Correcto<br /> (a + b) &amp; c<br />

Declaraciones Switch

• El case debe estar en la misma columna que el switch
• Cada declaración case debe tener un break (o return) al final o un comentario que indique porque intencionalmente no hay un break

<br /> switch (myEnum) {<br /> case Value1:<br /> doSomething();<br /> break;<br /> case Value2:<br /> doSomethingElse();<br /> // fall through<br /> default:<br /> defaultHandling();<br /> break;<br /> }<br />

Saltos de linea

• Limite el largo de las lineas a 100 caracteres, inserte saltos de linea si son necesarios

• Las comas van al final de una línea quebrada, los operadores deben empezar al principio de la nueva línea. Un operador al final de la línea no es fácil de ver si el editor es demasiado estrecho.

<br /> // Correcto<br /> if (longExpression<br /> + otherLongExpression<br /> + otherOtherLongExpression) {<br /> }

// Incorrecto<br /> if (longExpression +<br /> otherLongExpression +<br /> otherOtherLongExpression) {<br /> }<br />

Herencia y la keyword `virtual`

• Cuando reimplemente un método virtual, no ponga la keyword `virtual` en el archivo header.