Las siguientes son algunas de las mejores prácticas para hacer que el código sea más legible:
Nombramiento: Esta es una de las cosas más importantes. Los nombres de variables y funciones deben ser descriptivos. Los nombres de las variables de una letra como i, j, x solo deben reservarse para bucles. Use la separación camelCase o under_score para nombres largos de variables.
Formato : El formato debe ser consistente. Siempre sangra bloques anidados. La sangría de 4 espacios es una práctica común. Siga las guías de estilo ampliamente utilizadas con más detalles, por ejemplo, Google Java Style, Bienvenido a Python.org, etc.
No se repita: si se encuentra reescribiendo un bloque de código lógico, reemplácelo con una función.
- Cómo evitar ser influenciados por personas groseras en el lugar de trabajo.
- Algunas personas dicen que los diferentes grupos de edad tienen diferentes gustos en el contenido de Internet. ¿Qué piensas?
- ¿Qué sucede cuando se desenmascara un narcisista y se revelan sus secretos?
- ¿Los chicos confiados se ponen nerviosos en sus enamoramientos?
- ¿Cuál es la respuesta más irritante?
Longitud de la función: las funciones excesivamente largas hacen que el código sea más difícil de leer y comprender. Si una función es demasiado larga (no cabe en la pantalla, por ejemplo), divídala en varias funciones.
Comentarios: Escribe comentarios donde sea necesario. No escriba comentarios obvios y no comente en cada línea. Escriba comentarios para explicar decisiones de diseño, algoritmos complejos y lógica específica de dominio.
Espacio en blanco : bloques lógicos separados de código por líneas nuevas.