La peor práctica es dejar comentarios para todo.
Un comentario debería aclarar una regla de negocio que el código por si mismo no puede explicar.
Idealmente el código debería ser autoexplicativo.
En lenguajes como Python se puede aclarar qué hace y qué retorna cada función o una clase mediante docstrings (e incluso docstrings a nivel módulo).
Y luego, un buen README o al menos un diagrama que explique el proceso, su paso a paso, etc., debería ser un MUST, y más en esta época donde con la IA puedes documentar mucho más rápido.
BONUS: que los mensajes de los commits que acompañan al código también expliqué el qué y el para qué. El log bien construido es una herramienta muy poderosa.
¿Me estoy olvidando de algo?
in engineering, the lowest performers tend to talk the most.
compensation and progression is largely broken because non technical folks are put in charge to measure the growth of engineers they don’t understand.
it’s simple, engineer are doing well if they’re able to:
- progressively work in less well defined initiatives
- become the go to person when others are stuck
- demonstrate deep ownership
This was the very moment America was introduced to drifting 2004 Irwindale D1GP, the first time ever on American soil. Personally, I think this was the event that set North America on a whole new trajectory in drifting.