Difference between revisions of "Buenas prácticas"

Revision as of 12:44, 21 May 2016

Siempre, para cualquier archivo de trabajo, por muy insignificante o borrador que parezca, utiliza uno de los repositorios compartidos:
- Software y hardware: GitHub (GIT, público)
- Redacción de publicaciones: Consultar para la URL exacta, distribuidos a través de http://robots.uc3m.es/svn/* (SVN, privado)

CMake para cualquier proyecto C/C++.
Utiliza UpperCamelCase para nombres de librerías y de clases.
Utiliza lowerCamelCase para nombres de ejecutables.
NO utilizar números en nombres de ficheros para indicar versiones/intentos/iteraciones... ¡Para eso ya existen los hash y tag de los sistemas de control de versiones!
Mantén un main() minimalista: implementa tu programa como una clase.
- En C++ solemos hacer que la clase principal herede de yarp::os::RFModule, con lo cual se dispone de un configure(yarp::os::ResourceFinder& rf) que recibe un diccionario (rf) pasado desde el main(), un close() que se llama con la señal CRTL+C, y una función updateModule() llamada periódicamente, con una periodicidad lenta [segundos] dada por getPeriod(). Si se necesita una función que se llame rápidamente, heredando de yarp::os::RateThread se obtiene una función run() que es llamada con una periodicidad [milisegundos] especificada en el constructor.
Si tienes un dispositivo, impleméntalo como una clase, idealmente como un YARP device.
Tests, tests, tests! Idealmente, para cada clase, y desarrollado a la par de la clase.

@@ Line 1: / Line 1: @@
-* Utiliza siempre uno de los repositorios compartidos:
+* '''Siempre''', para cualquier archivo de trabajo, por muy insignificante o borrador que parezca, utiliza uno de los repositorios compartidos:
 ** Software y hardware: [https://github.com/roboticslab-uc3m GitHub (GIT, público)]
 ** Redacción de publicaciones: Consultar para la URL exacta, distribuidos a través de http://robots.uc3m.es/svn/* (SVN, privado)