Escribe para ser revisado
Mejor práctica 4: el código debe redactarse para ser revisado
Mientras escribe su código de software, tenga en cuenta que alguien va a revisar su código y tendrá que enfrentar críticas sobre uno o más de los siguientes puntos, pero no limitado a:
- Mala codificación
- No siguiendo el estándar
- No tener en cuenta el rendimiento
- Historial, sangría, comentarios no son apropiados.
- La legibilidad es pobre
- Los archivos abiertos no están cerrados
- La memoria asignada no se ha liberado
- Demasiadas variables globales.
- Demasiada codificación.
- Manejo deficiente de errores.
- Sin modularidad.
- Código repetido.
Mantenga todos los puntos mencionados anteriormente en su mente mientras codifica y deténgalos antes de que salten en su código fuente. Una vez que haya terminado con su codificación, realice una autoevaluación al menos una vez. Estoy seguro de que una autoevaluación lo ayudaría a eliminar usted mismo el 90% de los problemas.
Una vez que haya terminado por completo con su codificación y auto revisión, solicite a su compañero una revisión del código. Recomiendo encarecidamente aceptar los comentarios de revisión con gusto y agradecer a los revisores de su código por los comentarios. Al mismo tiempo, nunca es bueno criticar ningún código fuente escrito por otra persona. Si nunca lo hizo, inténtelo una vez y verifique la expresión del codificador.
Acepte las críticas pero no critique
El código fuente mal escrito te enseña a escribir un buen código fuente siempre que lo tomes positivamente y aprendas una lección de él.
Su objetivo debe ser detener los errores en primer lugar y crear un código LIBRE DE ERRORES. Piense como un probador, de modo que debería tener un desafío para los probadores.