Cuando se escribe código para un programa, es fácil corregir todos los errores y hacer que se compile correctamente, pero es más difícil para otra persona leerlo. Aquí hay algunos consejos que lo ayudarán a mejorar la legibilidad de su código.

Pasos

  1. 1 Las personas que mantienen el código nunca son tan versadas como el autor original. Pueden tener habilidades de programación más pobres y sabrán menos sobre el proyecto. Esta es la persona para la que está escribiendo el programa. Quieres que el código sea fácil para esta persona.
  2. 2 Solo porque una característica del idioma esté disponible en un idioma, no significa que deba usarla. El objetivo es comunicar lo que el código hace al siguiente lector, no impresionarlo con la cantidad de líneas que puede tomar para escribir el código.
  3. 3 A menudo, un algoritmo es difícil de seguir. Pero a menudo se publica en alguna parte. Coloque el URI de la documentación del algoritmo en la sección de comentarios del código. Si el URI apunta a una ubicación que es efímera, copie la información en algún lugar donde el desarrollador del código pueda encontrarla.
  4. 4 Haga referencia al estándar de codificación en el encabezado del archivo. Si es posible, proporcione un archivo que las herramientas puedan abrir para incorporar la configuración correcta. Como ejemplo, Eclipse usa pestañas por defecto, pero las pestañas se representan de manera diferente en diferentes editores de texto. Puede ser preferible usar espacios en blanco en lugar de pestañas, pero tener un archivo que proporcione la configuración adecuada para un proyecto.
  5. 5 Usa espacio en blanco Omita las líneas entre códigos que hacen cosas diferentes, y use espacios después de los puntos y comas. Esto hará que su código se vea más limpio y más fácil de leer.
  6. 6 Sangría dentro de llaves. Esto hace que sea obvio que un trozo de código está separado de otro. Esto puede ayudar al escribir un método largo. Sangría adentro si las declaraciones y bucles lo harán fácil de leer. Esta técnica se llama anidamiento, es decir, muestra que un trozo de código está "anidado" dentro de otro trozo de código, y permite al lector seguir fácilmente el patrón de anidación.
  7. 7 Escribe comentarios descriptivos. Suponga que la persona que lee su código no sabe nada de lo que se supone que debe hacer. Tus comentarios deberían explicar cada paso del camino. Todas de sus algoritmos avanzados, confusos o complicados debe ser bien comentado. Además, intenta describir el propósito del código. Por ejemplo, en lugar de escribir "agregar uno a la variable", indique por qué esto es importante en el código, ya que cualquiera puede ver que está incrementando la variable, por ejemplo, "incremente el número de visitas de página en 1".
  8. 8 Haga que su código sea "auto-documentado" creando nombres descriptivos de objetos que describan sus propósitos. Los objetos deben hacer referencia al dominio del problema o a los artefactos de software estándar. Una lista es una lista. Es posible que deba crear una Lista de clientes que subclasifique o implemente una Lista. Las variables y los parámetros de función deben tener nombres descriptivos.
  9. 9 Incluya el autor original y el actual mantenedor del código en el comentario inicial del archivo. Esto les dice a las personas a quién deben acudir para dar servicio al código.
  10. 10 Comenta a menudo. Escribe comentarios para indicar tu intención. Al comentar su código, alguien borrará sus comentarios.