Ya se ha dicho innumerables veces, pero hacer que su código sea legible es claramente una de las primeras cosas que debe aprender. Utilizo algunas técnicas para lograr la máxima legibilidad:
- Tener algunas buenas convenciones de codificación.
- Una función o un método debe comenzar con un verbo, el nombre de la función debe describir la acción. Por ejemplo, prefiera
computeSpeedOfCar(…)
lugar despeedOfCar(…)
para no confundir una función con una variable. No temas ser verboso. - Los nombres de variables deben describir las cosas que tienen, no su tipo. Debe describirlo de manera que el lector pueda deducir fácilmente el tipo. Por ejemplo, para un vector de objetos de tipo Car, prefiera
cars
lugar devcar
. - El uso de guiones bajos (
camelCase
osnake_case
) para separar las palabras en su función y nombres de variables depende de usted, pero solo elija algo y cúmplalo durante todo el proyecto. - Tener una buena manera de diferenciar miembros, variables y argumentos. Personalmente, trato los argumentos de la misma manera que las variables locales (porque dentro de la función no hay una diferencia real), y uso algo que puede diferenciar a los miembros, por ejemplo, un prefijo
m_
en C ++, o un subrayado final. El subrayado final es bastante bueno porque facilita la finalización del código. - Sangría Si utiliza espacios o tabulaciones, el ancho de los mismos o la convención que utiliza para dar formato a su código, es irrelevante. Sólo apégate a ello. Si llegas a un equipo que ya lo tiene, apégate a él. En tus proyectos personales, prueba varios hasta que encuentres el más cómodo para ti. Pero siempre mantén lo mismo en todo tu proyecto.
- Tener un código bien documentado.
- Escribir comentarios en el encabezado de la función. Debe mostrar el uso de la función, los significados de los argumentos, el valor de retorno, cualquier
TODO
s oFIXME
s, las excepciones que pueden lanzarse y, si es posible, un ejemplo de uso. - Separa tu código en bloques lógicos. Deja líneas vacías. Escribir comentarios sobre bloques lógicos. Un truco para hacerlo correctamente al escribir una nueva función es escribir primero los pasos del algo en los comentarios, uno por línea. Luego, después de cada línea de comentario, escriba el código correspondiente.
- Mantenga sus comentarios al día!
- Siempre que necesite cambiar algo en una función, planifíquelo con cuidado: ¿ya se usa en algún lugar? ¿El cambio romperá algo en otra parte del programa? ¿Debo escribir una nueva función? ¿Debo agregar un argumento a la función para esa nueva característica? etc.
- Escribe código para que sea autoexplicativo. Todos fallamos a veces al escribir comentarios. Si el código es lo suficientemente claro, la falta de comentarios no será tan mala y podrá agregarlos más tarde. Además, cuanto más legible sea el código, más fácil será depurarlo, mejorarlo y compartirlo con amigos o colegas.
Y algunos otros puntos:
- Usar control de fuente
Ya se ha dicho anteriormente, pero use control de código fuente. Git está en el aire, pero prepárate para cambiar a algo más poderoso (y / o más complicado) en los próximos años. Comencé con SourceSafe, luego CVS, luego SVN, luego GIT. No temas el cambio.
- Código simple
No es necesario hacer las cosas simples complicadas. Código sencillo. Mantenlo simple y estúpido (principio KISS). Si funciona sin errores, no es estúpido.
- Cómo ser más productivo en mi nuevo piso independiente.
- ¿Cuál es la estación de trabajo ergonómica ideal y los hábitos de trabajo?
- ¿Cuáles son algunos de los hábitos de programación más excéntricos que has visto?
- Cómo abordar el hábito del diario.
- ¿Qué es lo opuesto a la lujuria?
- La optimización temprana es la raíz de todo mal.
Hacer que las cosas funcionen. Si hay un problema en el rendimiento, cronometra tu código. Encuentra los cuellos de botella. Optimizar solo los cuellos de botella. Trate de mantenerlo legible. Explica las técnicas de optimización que usaste en los comentarios.
- Mantenerse humilde
Una buena cualidad de un buen programador es la humildad. Nunca se avergüence de llamar a un colega en busca de ayuda, es mucho mejor que quedarse atascado en su código durante horas. Además, si encuentra un error, verifique su código antes de culpar a sus colegas. Nunca calcule que su forma de pensar un algo es mejor que la de sus colegas. Discuta sobre esto, tal vez encuentre una solución que sea mucho mejor que cualquiera de sus propuestas. Después de todo, usar 2 o 3 cerebros generalmente conduce a mejores resultados que usar solo un cerebro.
- Siempre aprende cosas nuevas
Pruebe nuevas técnicas, nuevos idiomas, nuevos paradigmas, nuevas API, nuevas herramientas. Siempre. Un buen programador sabe cómo evolucionar y seguir el progreso. No te quedes con un idioma en particular. Ten una favorita, pero no la conviertas en una religión.
- Por último, si bien no menos importante
Se apasionado. Si no lo eres, nunca serás mejor que todos los programadores de COBOL que se sientan frente a su mainframe desde los años 50. No los culpo, deben hacer un montón de dinero. Pero si quieres ser un buen programador, el dinero no cuenta, así que sé apasionado. Y, tal vez, el éxito vendrá para que el dinero venga con su pasión.