Cómo verificar la calidad del código que he escrito

Recomiendo altamente este libro:

Código limpio: Un manual de artesanía de software ágil: Robert C. Martin: 9780132350884: Amazon.com: Libros

Este libro te enseña los conceptos básicos para escribir un buen código. Este libro solo probablemente me convirtió en un programador 1.5 veces mejor.

Sin embargo, estoy totalmente de acuerdo con la respuesta contraída (“revisión por pares”), porque la forma más rápida de verificar la calidad de su código y aprender de él es que alguien más lo lea y le diga qué sentido tiene.

Consulte esta guía para verificar la calidad del código:

En términos de fallas de diseño, acepte que hasta que tenga años de experiencia en el mantenimiento del código que ya ha escrito, todo su código tendrá fallas de diseño (sé que el mío sí). Una vez que tenga suficiente experiencia, el diseño de su código comenzará a ser más una cuestión de compensaciones, en lugar de ser defectuoso / menos defectuoso. Realmente lo importante es que realmente te importa, conozco a demasiadas personas que no lo hacen.

El libro de Patrones de diseño de GoF es un buen punto de partida para poder razonar sobre las compensaciones de diseño, pero tenga cuidado de exagerar con los patrones de diseño. Los patrones de diseño ayudan a crear código extensible, pero solo debes usar uno cuando lo necesites. En general, es mejor escribir código que sea lo más simple posible que el código que puede extender en cualquier dirección pero que requiere muchos ejercicios mentales para que alguien nuevo en su proyecto lo entienda.

“Lo suficientemente bueno” realmente depende del contexto en el que vive su código. Lo que está haciendo, quién depende de ello, cuántas personas necesitarán trabajar con él en el futuro. Básicamente, su objetivo debe ser escribir un código que sea lo suficientemente bueno como para que quien quiera cambiarlo en el futuro no maldiga su nombre; en algunas situaciones, puede ser el único mantenedor futuro por el que debe preocuparse.

Es bueno que te importe escribir un buen código, pero no tengas miedo de escribir un código malo inicialmente. Escribir código es muy parecido a escribir un ensayo o una novela, ya que tienes que escribir tus pensamientos crudos antes de tener algo con lo que realmente puedas trabajar y evolucionar con el tiempo.

Cada desarrollador, que busca escribir código de alta calidad, primero debe adquirir el conocimiento requerido que le permite escribir código de calidad. Esto se puede hacer leyendo buenos libros y artículos sobre el tema, viendo charlas de expertos en dominios directamente en una conferencia o sin conexión a través de YouTube.

Aquí hay un conjunto de libros que encontré particularmente útiles para escribir código de alta calidad:

  1. Refactorización: Mejora del diseño del código existente: Martin Fowler
  2. Code Complete: A Practical Handbook of Software Construction, Second Edition: Steve McConnell
  3. Código de calidad: la perspectiva de código abierto: Diomidis Spinellis
  4. Código limpio: un manual de artesanía de software ágil: Robert C. Martin
  5. Gestión de la deuda técnica: Girish Suryanarayana, Ganesh Samarthyam, Tushar Sharma (Descargo de responsabilidad: soy coautor de este libro)

El segundo aspecto de escribir código de alta calidad es el cumplimiento (para verificar si el código escrito es de la calidad requerida). Se pueden usar herramientas de calidad de código para detectar varios olores de código. Aquí se puede encontrar una lista relativamente completa de herramientas que admiten el análisis de calidad del código (mre / awesome-static-analysis).

Sugeriría un enfoque de 3 pasos 😉

  1. Mantenga el ciclo de retroalimentación muy corto utilizando un buen ‘linter’ en su IDE, esto lo ayudará a solucionar la fuga al crear un nuevo código.
  2. Automatice el análisis de calidad de código en su solicitud de extracción agregando una herramienta como BetterCodeHub a su CICD en GitHub, esto le dará una definición de hecho a nivel de base de código.
  3. Happy Coding, Michiel

(Descargo de responsabilidad, trabajo para la empresa)

Aquí hay un artículo en el que destaco los beneficios de automatizar las revisiones de calidad del código Revisión automática de código – Kiuwan

También puedes usar la herramienta gratis 🙂
¡Esperamos que te sea útil!

Puede consultar el increíble nombre de marco basado en asp.net de código abierto Asp.net Boilerplate. Mire la documentación y vea cómo su código se compara con el marco.