Breaking

Post Top Ad

Your Ad Spot

domingo, 25 de marzo de 2018

8 Reglas para tener el mejor estilo de programación

Resultado de imagen para programadores

Legibilidad

El buen código está escrito para que los colegas lo entiendan fácilmente. Está formateado correcta y consistentemente y utiliza nombres claros y significativos para funciones y variables. Comentarios concisos y precisos describen un natural descomposición de la funcionalidad del software en simple y específico funciones. Cualquier sección difícil se nota claramente. Debería ser fácil ver por qué el programa funcionará y la razón de que debería funcionar en todos los casos imaginables.

Mantenibilidad

El código debe escribirse para que sea sencillo otro programador para corregir errores o realizar cambios en su funcionalidad más adelante. La función debe ser general y suponer lo menos posible acerca de las condiciones previas. Todos los valores importantes deben marcarse como constantes que se pueden cambiar fácilmente. El código debe ser robusto para manejar cualquier entrada posible y producir un resultado sin estrellarse. Se deben enviar mensajes claros para la entrada que no sea permitido.

Comentarios

Los comentarios son el primer paso para hacer un programa de computadora humano legible. Los comentarios deberían explicar claramente todo sobre un programa que no es obvio para un programador par. El volumen de comentarios escritos es sin sentido, la calidad es lo único que cuenta.

Los comentarios de bloque se escriben usando / * comments * / style. Deben ir en la parte superior de cada fuente archivo y generalmente incluyen su nombre, la fecha en que se escribió su código y descripción general del propósito de ese programa. Los comentarios de bloque también deberían
precede a la mayoría de las funciones con una descripción del propósito de la función; estos pueden
se omite solo para funciones muy breves y obvias.Los comentarios en línea se escriben como // comentarios, deben ir cerca de las líneas de código importantes dentro de funciones o con variables cuando se inicializan.

Nombrando

Los nombres dados a las clases, variables y funciones deben ser inequívoco y descriptivo. Otras pautas para nombrar son:
  1. La mayúscula se usa para separar nombres de varias palabras: StoneMasonKarel. 
  2. La primera letra de un nombre de clase siempre está en mayúscula: GraphicsProgram
  3. La primera letra de una función o nombre de variable está siempre en minúsculas: setFilled ().
  4. Los nombres x e y solo deben usarse para describir coordenadas
  5. Los nombres i, j y k solo deben usarse como variables en para bucles.
  6. Se deben evitar otros nombres de una letra: area = base * altura en lugar de a = b * h.
  7. Los nombres de las constantes están en mayúscula, con guiones bajos para palabras separadas: BRICK_COLOR.
  8. Use abreviaciones con precaución. max en lugar de máximo es bien, pero xprd en lugar de crossProduct es un problema.
  9. Leer también: La historia de la programación de idiomas Infografía

Sangría

La sangría se utiliza para marcar claramente el flujo de control en una programa. Dentro de cualquier bloque entre corchetes, todo el código está sangrado en una sola pestaña. Esta incluye el cuerpo de la clase en sí. Cada adicional para, while, if o switch estructura introduce un nuevo bloque que está indentado, incluso si los paréntesis son omitido para declaraciones de una línea. Para declaraciones if, cualquier otro correspondiente las declaraciones deben alinearse

Espacio en blanco

El espacio en blanco no tiene sentido para los compiladores, pero debe usarse consistentemente para mejorar la legibilidad Por lo general, quedan tres líneas en blanco entre funciones. Las líneas en blanco individuales se usan dentro de las funciones para separar secciones clave El uso de espacios también varía, pero generalmente inserta un espacio hacer que la expresión sea más legible; siguiente = 7 * (anterior - 1) es claro que el siguiente = 7 * (prev-1).

Uso de la función
La función debe ser corta y lograr una clara, específica tarea. En la medida de lo posible, deberían considerarse "cajas negras" que no depende de cualquier cosa excepto sus parámetros y puede manejar cualquier posible entrada graciosamente. Una regla empírica común es la "regla de las diez líneas", que generalmente funciona más de diez líneas intentan hacer demasiado y deberían simplificarse. Otro aspecto importante de las funciones es que cualquier repetición los segmentos de código deben convertirse en una función separada. Esto acortará su programa y mejorar la legibilidad.

Salida
Un aspecto final, pasado por alto del buen estilo de programación es cómo nuestros resultados de salida del programa e información para los usuarios. Parte de la escritura los programas de aspecto profesional proporcionan instrucciones y resultados claros para los usuarios de nuestros programas. Esto significa inglés correcto sin condiciones de error ortográfico. Uno siempre debe suponer que los programas de escritura serán utilizados por alguien sin comprensión de la programación informática en absoluto. Si te gustó el artículo, por favor compártelo!

No hay comentarios.:

Publicar un comentario

Dejanos tu comentario para seguir mejorando!

Post Top Ad

Your Ad Spot

Páginas