|
|
| Line 3: |
Line 3: |
| | == Buenas prácticas (IMPORTANTE! LEER PRIMERO!!) == | | == Buenas prácticas (IMPORTANTE! LEER PRIMERO!!) == |
| | | | |
| − | * '''Siempre, para cualquier archivo de trabajo, por muy insignificante o borrador que parezca,''' utiliza uno de los repositorios compartidos:
| + | https://github.com/roboticslab-uc3m/best-practices/blob/develop/buenas-practicas.md |
| − | ** Software y hardware: [https://github.com/roboticslab-uc3m GitHub (GIT, público)]. Consulta con tu tutor (que posiblemente te redirija a Juan, David o Raúl) si dudas en qué repositorio trabajar. Acomoda tu [https://git-scm.com/docs/gitignore .gitignore] al tipo de proyecto, para evitar subir ficheros que no se deberían (binarios, backups, y ficheros residuales varios).
| |
| − | ** Redacción de publicaciones: Consulta con tu tutor (que posiblemente te redirija a Juan) para la URL exacta, distribuidos a través de http://robots.uc3m.es/svn/* (SVN, privado)
| |
| − | * '''Siempre, cuando tengas una duda, busca en esta wiki, y busca entre las issues (tanto abiertas como cerradas) del repositorio asociado a tu trabajo.''' Si no encuentras respuesta, <u>pon una issue en el repositorio asociado a tu trabajo (o comenta en la pestaña de Discussion de la wiki)</u>. Ventajas:
| |
| − | ** Incrementa la productividad global, porque queda el histórico. Se tiende a evitar el estar repetiendo las mismas preguntas y generando las mismas respuestas.
| |
| − | ** Sirve de herramienta para tratar de mantener lo técnico dentro del contexto técnico, y a centrarse la temática indicada en el asunto de la issue.
| |
| − | ** Da mayor visibilidad a tu duda, te puede contestar gente que no te esperarías. Esto es especialmente interesante cuando hay un desacuerdo entre dos partes: pueden intervenir terceros que aporten nuevas ideas y puntos de vista.
| |
| − | * La forma preferida de documentación (salvo Doxygen para C/C++) es Markdown.
| |
| − | | |
| − | == Programación en General ==
| |
| − | * Respeta las sangrías/indentaciones... como si todo fuese Python! ;-) PD: Existe un programa que autoajusta, que se llama astyle (utilizar con precaución!).
| |
| − | * 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!
| |
| − | * NO crear DUPLICADOS de programas. Analizar en profundidad si se puede ampliar la funcionalidad de un programa a través del ajuste o incorporación de parámetros antes de crear un programa nuevo. Una vez detectado que se puede ampliar la funcionalidad de un programa, utilizar los mecanismos convencionales (issues, o fork y pull request).
| |
| − | * [http://robots.uc3m.es/dox-asibot-main/post_install.html#post_install_changing_parameters Cabeceras, ficheros de configuración y parámetros de CLI].
| |
| − | * Lee acerca de [https://www.google.es/search?q=cleancode Clean code].
| |
| − | | |
| − | == Programación C/C++ ==
| |
| − | * Para crear un nuevo proyecto C/C++, utiliza [https://github.com/roboticslab-uc3m/project-generator project-generator].
| |
| − | * Si hay problema con project-generator, [https://github.com/roboticslab-uc3m/project-generator/issues coméntalo en su sección de issues]. Si sigues con motivos en contra, por lo menos no dejes de utilizar [http://asrob.uc3m.es/index.php/Tutorial_CMake CMake] para cualquier proyecto C/C++.
| |
| − | * Utiliza UpperCamelCase para nombres de librerías y de clases.
| |
| − | * Utiliza lowerCamelCase para nombres de ejecutables.
| |
| − | * Evita el uso de variables globales.
| |
| − | * Preferimos el uso de la clase std::string frente a alternativas como char* o yarp::os::ConstString.
| |
| − | * Crea tus clases dentro de un namespace.
| |
| − | * Mantén un main() minimalista: implementa tu programa como una clase.
| |
| − | ** En C++ solemos hacer que la clase principal herede de [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html yarp::os::RFModule], con lo cual se dispone de un [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#a6c3880961b00b0a7eb527d62214169b7 configure(yarp::os::ResourceFinder& rf)] que recibe un diccionario ([http://www.yarp.it/classyarp_1_1os_1_1ResourceFinder.html rf]) pasado desde el main(), un [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#a58ce26fc6fdcb6eb4af8e8dc678e095e close()] que se llama con la señal CRTL+C, y una función [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#a37ee5baa17ce243458a1dff209e878b7 updateModule()] llamada periódicamente, con una periodicidad lenta [segundos] dada por [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#ace2fdadde1a2690f274079fabd6420d2 getPeriod()]. Si se necesita una función que se llame rápidamente, heredando de [http://www.yarp.it/classyarp_1_1os_1_1RateThread.html yarp::os::RateThread] se obtiene una función [http://www.yarp.it/classyarp_1_1os_1_1RateThread.html#ac3c97e766733b41a45c799aa0c05598f run()] que es llamada con una periodicidad [milisegundos] especificada en el constructor.
| |
| − | * Si tienes un dispositivo, también impleméntalo como una clase, idealmente como un [http://asrob.uc3m.es/index.php/Tutorial_yarp_devices YARP device].
| |
| − | * Crea un test para cada clase, desarrollándolo a la par de la clase. En la actualidad utilizamos '''gtest''', como en [https://github.com/roboticslab-uc3m/teo-main/tree/develop/test/testKdlSolver.cpp teo-main/test/testKdlSolver] y [https://github.com/roboticslab-uc3m/teo-body/tree/develop/tests/testTechnosoftIpos/testTechnosoftIpos.cpp teo-body/tests/testTechnosoftIpos].
| |
| | | | |
| | == AVISO IMPORTANTE: Al proceder, se aceptan las condiciones anteriores == | | == AVISO IMPORTANTE: Al proceder, se aceptan las condiciones anteriores == |
