¿Hay normas y prácticas básicas para hacer el código legible por humanos?

Question

Más específicamente editar HTML, Java y Python más legible? ¿Alguien tiene sugerencias para este estudiante de programación?

Answer 1

1. Uso carcasa consistente y nomenclatura.

2. Use pestañas (y los soportes donde esté disponible) para proporcionar un flujo visual.

3. Use los comentarios que explican lo que está sucediendo tanto conceptual como técnicamente. (Por ejemplo, // ¿Tenemos un usuario válido? // Comprobar que no user_ID no es -1)

Estoy seguro de que algunos desarrolladores más experimentados tendrán más sugerencias, pero los que son mi top 3.

Answer 2

La sangría adecuada e informativos comentarios.

Answer 3

El uso de indentación, comentarios y convenciones de codificación (para Python comprobar PEP8 )

Answer 4

Asegúrese de que el código está bien estructurado (sangrado adecuado, líneas en blanco a distintas secciones de código, etc.) y el uso estándar, consistente y totalmente nombrado (en lugar de incomprensibles abreviados) los nombres de variables.

Otros sugieren el uso de los comentarios adecuados. Yo más bien en desacuerdo. Si el código está bien estructurado y variables bien nombrado, a continuación, los comentarios se acaba el desorden de las cosas. La excepción a la regla es cuando se debe hacer algo contrario a la intuición para trabajar en torno a un fallo en otro lugar (he tenido que recurrir a esto en código de WCF y Entity Framework en el pasado).

Answer 5

Trate de leer su código en voz alta (o al menos en su cabeza).

Answer 6

Tener un vistazo a este libro: código limpio: un manual de la artesanía de software ágil . Se trata de hacer un código legible y comprensible.

Answer 7

Un consejo es no ser perezoso con nombres. Por ejemplo, si usted tiene una clase Java que es una implementación de la interfaz del transformador, y se transforma String a Date, no dude en nombrar el StringToDateTransformerImpl clase.

Answer 8

Bueno, siempre se puede utilizar la "prueba de ignorantes". Muestra el código en alguien que no sabe absolutamente nada de programación. Si él puede ver más o menos lo que hace una función, el código es probablemente legible.

Answer 9

muesca adecuada al escribir HTML puede ser un salvavidas, sobre todo cuando se está interactuando con cualquier tipo de elementos anidados. Apenas sea consistente con la ranura y asegúrese de actualizar las líneas que rodea al mover o eliminar un elemento sangría. Esto hace que sea mucho más fácil de actualizar la página, ya que el nivel de sangría que le dará una idea de dónde se encuentra en la página sin tener que recurrir a algún tipo de maniobra Ctrl + F.

También vale la pena señalar que si estás usando CSS en combinación con HTML, denominación adecuada es fundamental! Además, mejorará su flujo de trabajo y la legibilidad del código.

También soy un gran fan de la sangría, el espaciado y los comentarios al escribir "verdadero" código (Java, Python, C, etc.). Me inclino por (x + 1) a través de (x + 1) porque personalmente creo que hace una gran diferencia en la legibilidad. espacio que fuera yesos, incrementos, etc., y que llaman mi atención mucho más fácilmente. Sea consistente con su estilo de soporte / muesca y comentario liberalmente - recuerde, re-escribir un nombre de método no es un comentario