Notas de estilo que usan algunos programadores de KDE
Introducción
En IGLUES estábamos buscando una guía de estilo de KDE y al final he preguntado y hemos llegado a esta pequeña miniguía.
¿Hay alguna guía de estilo de programación de KDE?
No. Precisamente, se deja que cada uno tenga su estilo de programación para que nadie se sienta molesto por usar un estilo de programación que no le guste y se especifica claramente que si se toca código que no sea tuyo, debes usar el estilo que use el desarrollador original.
La verdad es que al final casi todos usamos el mismo estilo (al menos en las librerías sí que hay uno solo)
Lo normal es:
Todo en Inglés. Comentarios, nombres de variables, clases,...
Todo en C++. El lenguaje de programación es el C++.
Las variables de una clase se llaman siempre m_nombreDeLaPropiedad, por ejemplo m_name y no m_strname (insertando el tipo string en el nombre).
Los nombres de las clases, siempre empiezan en mayúsculas.
Los nombres de las funciones miembros de una clase siempre en minúsculas.
Cuando es una palabra compuesta se juntan y se pone la primera letra de cada palabra en mayúsculas y el resto en minúsculas (incluida la primera letra del nombre de la función) por ejemplo: int elementName() const { return m_elementName; };. Creo que m_ viene de member. La idea es poder distinguir rápidamente las variables de una clase y las locales de la función que estás leyendo que nunca llevan m_.
No se pone nunca "get" para indicar que es una función que devuelve un valor sino simplemente el nombre de la propiedad que devuelve. En vez de getValue/setValue o get_value/set_value nosotros usamos sólo value/setValue.
Cuando vienen del designer o de un precompilador las clases padre se suelen llamar NombreBase las hijas, que es donde se hace la implementación real de la clase, lo mismo sin Base. Otra forma de decirlo: Se añade base al nombre cuando la clase "base" no se usa directamente en el código fuente.
Más información en sobre programación en KDE o QT:
Esta pequeña guía ha sido realizada comentando, en principio con Antonio Larrosa, y luego en la lista de correo de desarrolladores de KDE en español.
El objetivo era servir de base para la guía propia de los desarrolladores de BulmaGés, BulmaFact, ... En nuestro camino hacia KDEizarnos. Así que dejaremos esta versión para los compañeros de
KDE y haremos una variante con lo que queramos añadir para el caso especifico de IGLUES.
Si encontráis Algún error o tenéis alguna idea para mejorarla, estaremos encantados de que nos enviéis un email a
ochominutosdearco en yahoo.es.