lmtreser / good-code

Colección de guías y recursos para aprender y mejorar la práctica de escribir código, orientado principalmente a Arduino

Good Code

Guías y recursos para aprender y mejorar la práctica de escribir código, orientado principalmente a Arduino.

• Git
  • git Recursos sobre control de versiones
  • git/gitignore A collection of useful .gitignore templates
• Plantillas
  • templates/ArduinoLibraryExampleArduino Library Example
  • templates/arduTemplate Arduino Firmware Template
  • templates/platformio-examples-develop PlatformIO Project Examples
  • templates/wifiTemplate ESP8266/ESP32 WiFi Firmware Template
• Guías de estilo
  • code_style/buenas_practicas.ino Buenas practicas por Luis Llamas
  • code_style/arduino-style-guide.md Style guide for Arduino por @Irikos
  • code_style/SFECodeStyleGuide.md SparkFun Code Style Guidelines

---

¿Alguna vez te has topado con un código misterioso? ¡A todos nos ha pasado! 💪🏽

Desconcertado por nombres de variables crípticos, funciones interminables y comentarios confusos. Escribir código limpio es esencial para evitar estos escenarios y garantizar un proceso de desarrollo sin problemas. Hace que su código se explique por sí mismo, sea fácil de navegar y se pueda mantener, lo que le ahorra futuros dolores de cabeza.

La adopción de principios de código limpio mejora la legibilidad del código, facilita la depuración, reduce el costo de mantenimiento del programa, mejora la colaboración, mejora la calidad del código y te convierte en un mejor programador.

1. Utilizar nombres descriptivos. Los nombres claros y descriptivos hacen que el código sea más fácil de entender. Ya sea una variable, función o clase, su nombre debe reflejar su propósito.

2. Seguir el principio DRY. DRY (del inglés "Don't Repeat Yourself") significa "No te repitas". Si escribe el mismo código en varios lugares, deberá crear una función que pueda llamarse siempre que sea necesaria esa tarea.

3. Mantener las funciones pequeñas. Cada función debe hacer una cosa y hacerlo bien. Si las funciones son demasiado grandes y hacen demasiadas cosas, probablemente sea hora de dividirlas.

4. Escribir comentarios, pero sabiamente. Los comentarios son útiles pero no son una alternativa para el código limpio. Deberían explicar por qué se hace algo, no qué se hace. Recuerde, un buen código se documenta principalmente por sí mismo.

5. Refactorizar periódicamente el código. No tengas miedo de revisar el código y mejorarlo. A medida que adquiera más conocimientos y experiencia, encontrará mejores formas de hacer las cosas. La refactorización es parte del proceso de codificación.

Recordar: escribir código limpio requiere práctica, pero los beneficios valen la pena.

Recursos para seguir aprendiendo

• Arduino

  • 4 consejos para programar código más limpio en Arduino
  • Arduino documentation goes open-source for community contributions
  • Arduino Lint
  • Arduino programming traps, tips and style guide
  • Arduino Style Guide for Creating Libraries
  • Arduino Style Guide for Writing Content
  • Good Arduino Code
  • How to Write A Great Arduino Library
  • How to Write Clean Arduino Code
  • Programming Arduino Uno in pure C
  • The Arduino Language in 10 Points
  • Translate an Idea into Arduino Code
  • Writing a Library for Arduino

• Programación en general

  • 97 cosas que todo programador debería saber
  • C Coding Standard
  • C++ Cheat Sheets & Infographics
  • C++ Coding Standard
  • ClangFormat
  • Coding in C for MCUs: Sort Structs to Save Code Size
  • Guías de código abierto
  • Hacking C++
  • KTOWN's Guide to Readable C Code
  • PlatformIO Project Examples
  • References in C++

• Documentar código

  • AsciiDoc
  • Doxygen
  • MkDocs
  • The Markdown Guide

• Control de versiones

  • A successful Git branching model
  • Git Cheatsheet
  • Git y GitHub tutorial paso a paso
  • gitignore
  • Gitignore Explicado: ¿Qué es Gitignore, y cómo agregarlo a tu repositorio?
  • Oh My Git

Licencia

Este trabajo está protegido por la Licencia MIT. Puedes acceder a la versión original de la licencia (en inglés) a través del archivo LICENSE o en línea en The MIT License (MIT). También proporcionamos una traducción no oficial desde Wikipedia:

Copyright (c) 2024 Lucas Martín Treser

Por la presente se concede permiso, libre de cargos, a cualquier persona que obtenga una copia de este software y de los archivos de documentación asociados (el "Software"), a utilizar el Software sin restricción, incluyendo sin limitación los derechos a usar, copiar, modificar, fusionar, publicar, distribuir, sublicenciar, y/o vender copias del Software, y a permitir a las personas a las que se les proporcione el Software a hacer lo mismo, sujeto a las siguientes condiciones:

El aviso de copyright anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software.

EL SOFTWARE SE PROPORCIONA "COMO ESTÁ", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA, INCLUYENDO PERO NO LIMITADO A GARANTÍAS DE COMERCIALIZACIÓN, IDONEIDAD PARA UN PROPÓSITO PARTICULAR E INCUMPLIMIENTO. EN NINGÚN CASO LOS AUTORES O PROPIETARIOS DE LOS DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGUNA RECLAMACIÓN, DAÑOS U OTRAS RESPONSABILIDADES, YA SEA EN UNA ACCIÓN DE CONTRATO, AGRAVIO O CUALQUIER OTRO MOTIVO, DERIVADAS DE, FUERA DE O EN CONEXIÓN CON EL SOFTWARE O SU USO U OTRO TIPO DE ACCIONES EN EL SOFTWARE.