Difference between revisions of "Buenas prácticas"
Jump to navigation
Jump to search
Jgvictores (talk | contribs) |
Jgvictores (talk | contribs) |
||
| Line 12: | Line 12: | ||
* Si tienes un dispositivo, impleméntalo como una clase, idealmente como un [http://asrob.uc3m.es/index.php/Tutorial_yarp_devices YARP device]. | * Si tienes un dispositivo, impleméntalo como una clase, idealmente como un [http://asrob.uc3m.es/index.php/Tutorial_yarp_devices YARP device]. | ||
* Tests, tests, tests! Idealmente, para cada clase, y desarrollado a la par de la clase. | * Tests, tests, tests! Idealmente, para cada clase, y desarrollado a la par de la clase. | ||
| + | <!-- [http://robots.uc3m.es/dox-asibot-main/post_install.html#post_install_changing_parameters], [https://www.google.es/search?q=cleancode clean code]. --> | ||
Revision as of 12:50, 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)
- 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!
Programación
- Para crear un nuevo proyecto C/C++, utiliza project-generator.
- Si hay problema con project-generator, coméntalo en la sección de issues. Si sigues con motivos en contra, por lo menos no dejes de utilizar CMake para cualquier proyecto C/C++.
- Utiliza UpperCamelCase para nombres de librerías y de clases.
- Utiliza lowerCamelCase para nombres de ejecutables.
- 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.