Contenido

• Pasos
• Preguntas y respuestas de la comunidad
• Consejos

Otras secciones

Al escribir código para un programa, es fácil corregir todos los errores y hacer que se compile correctamente, pero facilitar que otra persona lo lea es mucho más difícil. A continuación, se incluyen algunos consejos que le ayudarán a mejorar la legibilidad de su código.

Pasos

1. 

   Las personas que mantienen el código nunca están tan bien informadas como el autor original. Pueden tener peores habilidades de programación 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. 

   
   
   El hecho de que una función de idioma esté disponible en un idioma no significa que deba usarla. El objetivo es comunicar lo que hace el código al siguiente lector, no impresionarlo con las pocas líneas que puede tomar para escribir código.

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 encargado del mantenimiento del código pueda encontrarla.

4. 

   
   
   Consulte el estándar de codificación en el encabezado del archivo. Proporcione un archivo si es posible que las herramientas puedan abrir para incorporar la configuración correcta. Como ejemplo, Eclipse utiliza pestañas de forma predeterminada, 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. 

   Usa espacios en blanco. Omita las líneas entre el código que hace cosas diferentes y use espacios después del punto y coma y las comas. Esto hará que su código se vea más limpio y más fácil de leer.

6. 

   Sangría en el interior de las llaves. Esto hace que sea obvio que un fragmento de código está separado de otro. Esto puede ayudar al escribir un método extenso. Sangrar el interior de las declaraciones if y los bucles facilitará la lectura. Esta técnica se llama anidamiento, es decir, muestra que un fragmento de código está "anidado" dentro de otro fragmento de código, y permite al lector seguir fácilmente el patrón de anidamiento.

7. 

   Escribe comentarios descriptivos. Suponga que la persona que lee su código no sabe nada sobre lo que se supone que debe hacer. Tus comentarios deben explicar cada paso del camino. Todas de sus algoritmos avanzados, confusos o complicados deben estar bien comentados. Además, intente describir qué propósito tiene el código. Por ejemplo, en lugar de escribir "agregar uno a la variable", diga por qué esto es importante en el código, ya que cualquiera puede ver que está incrementando la variable, por ejemplo, "incrementa el número de visitas a la página en 1".

8. 

   Haga que su código sea "autodocumentado" creando nombres de objetos descriptivos que describan cuáles son sus propósitos. Los objetos deben hacer referencia al dominio del problema o artefactos de software estándar. Una lista es una lista. Puede que tenga que crear una Lista de clientes que subclases o implemente una Lista. Las variables y los parámetros de función deben tener nombres descriptivos.

9. 

   Incluya el autor original y el responsable actual del código en el comentario inicial del archivo. Esto le dice a la gente a quién acudir para reparar el código.

10. 

    Comenta con frecuencia. Escribe comentarios para indicar tu intención. Sobre comentar su código conducirá a que alguien elimine sus comentarios.

Preguntas y respuestas de la comunidad

Consejos

• Hacer que su código sea más fácil de leer también lo ayudará a depurar su propio programa, haciéndolo más fácil para usted.
• Las variables constantes deben estar en mayúsculas, con palabras separadas por un guión bajo. Las variables regulares deben tener las primeras letras de cada palabra en mayúscula, omitiendo los guiones bajos.
• Agregue espacios en blanco si están permitidos.
• Si desea comentar una gran cantidad de texto, use "/ *" para iniciar el comentario y " * /" para finalizarlo. Entonces, no tienes que escribir "//" en cada línea. (Tenga en cuenta que hacer comentarios puede ser diferente en otros idiomas)
• Encuentre su estilo de escritura de código. Hay una variedad de estilos que puede utilizar, como los siguientes ejemplos: myVariable, MyVariable, myvariable, MYVARIABLE, My_Variable, MY_VARIABLE, my_variable, my_Variable, My_variable y más. Asegúrese de asignar cada estilo a un tipo específico como MY_VARIABLE para variables constantes y myVariable para variables regulares. Solo asegúrate de mantener la coherencia a través del estilo. No querrás terminar teniendo variables constantes myVariable y MY_VARIABLE.