馃 Formateado de C贸digo

Hay que tomar en consideraci贸n el formateado del c贸digo como una parte fundamental en pro de mantener un c贸digo limpio. Se deben elegir una serie de reglas sencillas que funcionen como reglas de formateado del c贸digo y que se apliquen de manera consistente. As铆 como establecer un compromiso de manera individual como en equipo a utilizar estas reglas de manera continua y para ello poder apoyarse de alguna herramienta que lleve acabo la revisi贸n y correcciones necesarias.

馃嵖 驴Para qu茅 formatear el c贸digo?

Formatear el c贸digo es importante, es una cuesti贸n de comunicaci贸n y la comunicaci贸n es parte fundamental de las habilidades de un programador profesional.

La funcionalidad que se crea el d铆a de hoy ser谩 reemplazada probablemente en el futuro, pero la facilidad de lectura tiene un profundo efecto en los cambios que se vayan a realizar. El estilo y legibilidad del c贸digo son precedentes que definir谩n la mantenibilidad y extensibilidad. El estilo y la disciplina sobrevive a trav茅s de estas futuras versiones, aunque las funcionalidades implementadas y el c贸digo asociado a estas no.

馃嵖 驴Qu茅 es el formateado de c贸digo vertical?

La cantidad de l铆neas de c贸digo que agregamos a un archivo representa la cantidad de c贸digo vertical. Por lo general se recomienda el n煤mero de l铆neas no exceda las 200 l铆neas de longitud, con un l铆mite total de 500. Esta regla no esta escrita en piedra y no se debe considerar como ley marcial, pero si algo deseable de seguir pues forma parte de las buenas pr谩cticas de programaci贸n ya que los archivos peque帽os son mas sencillos de entender que los largos.

馃嵖 驴En qu茅 consiste la met谩fora del peri贸dico?

Un art铆culo bien escrito se lee de forma vertical con facilidad. En la parte mas superior esperamos encontrar informaci贸n acerca de lo que trata la noticia. El primer p谩rrafo es una sinopsis de toda la historia y conforme se continua leyendo aparecen mas detalles acerca del art铆culo.

De igual forma como un articulo, un archivo con c贸digo debe de ser explicativo. El nombre como tal debe ser lo suficientemente descriptivo para comunicar la propia intenci贸n del mismo. La parte superior de este archivo debe contener los conceptos y algoritmos mas importantes. Conforme se desplace el c贸digo hacia abajo se ubicar谩n las funciones de menor nivel y otro tipo de detalles de menor relevancia.

馃嵖 驴Qu茅 es la densidad Vertical del c贸digo?

La densidad vertical del c贸digo implica asociaci贸n cercana. Las lineas de c贸digo que se encuentran cerca una de otra es porque tienen una relaci贸n entre s铆, entre mas cerca se encuentren esta dependencia es mayor.

馃嵖 驴Qu茅 es la distancia Vertical en el c贸digo?

Los conceptos que est谩n relacionados entre si deben est谩n cerca los unos de los otros en el espacio vertical. Esta regla no funciona para casos en los cuales los conceptos relacionados se encuentren en archivos diferentes. Considerando lo anterior es deseable que los conceptos que est茅n muy relacionados no se encuentren en archivos diferentes.

Para aquellos conceptos que se encuentran muy relacionados entre si, deben mantener una separaci贸n con otros tan grande como la necesidad de entender cada uno de estos conceptos de forma individual.

馃嵖 驴C贸mo debe formatearse la declaraci贸n de las variables?

馃嵖 驴C贸mo deben espaciarse las funciones dependientes unas de otra?

Si una funci贸n llama a otra, estas deben estar verticalmente cerca, y la que invoca colocada antes de la invocada.

馃嵖 驴Qu茅 es la afinidad conceptual?

Cuando ciertos bits desean estar cerca de otros, le llamamos a esto Afinidad Conceptual. Cuanto mas fuerte sea la afinidad menor es el espacio vertical entre ellas.

Esta habilidad puede basada en una dependencia directa como una variable llamando a otra, o utilizando una variable. Tambi茅n puede existir afinidad porque un grupo de funciones realizan una operaci贸n similar.

馃嵖 驴Qu茅 es el orden vertical?

Es deseable que una funci贸n llame dependencias que apunten en una direcci贸n hacia abajo, de forma que la funci贸n que sea invocada debe encontrarse mas abajo en la posici贸n vertical del c贸digo.

馃嵖 驴Cu谩l debe ser la longitud horizontal de las l铆neas de c贸digo?

La longitud horizontal recomentable de las l铆neas de c贸digo debe de ser del orden de entre los 100 y los 120 caracteres. Debemos mantener nuestras l铆neas cortas de forma que un monitor convencional nunca sea requerido el tener que hacer scroll de forma horizontal.

馃嵖 驴Qu茅 es la densidad horizontal en el c贸digo?

El espacio en blanco horizontal se usa para asociar y desasociar. Cuanto menor sea el espacio horizontal mayor sera la asociaci贸n.

Las expresiones tienen dos elementos principales que son la parte derecha e izquierda en la expresi贸n.

De igual forma la funci贸n y los argumentos est谩n ampliamente relacionados. Se sugiere separar los argumentos dentro de los par茅ntesis mediante un espacio despu茅s de la coma, indicando as铆 que existe una separaci贸n entre un argumento y otro.

Otra forma de asociaci贸n es la que existe en la precedencia de los operadores. El separarlos nos permite indicar como esta precedencia es llevada a cabo. Sin embargo muchos de los IDE se encargan de realizar este formateado ignorando este tipo de asociaciones.

馃嵖 驴Qu茅 es el alineado horizontal mediante tabulaciones en el c贸digo?

El alineamiento horizontal no es en realidad 煤til ya que enfatiza las cosas equivocadas y distrae la visi贸n de lo realmente importante como el tipo de la propiedad dentro de una clase.

Se pudiera argumentar que en una larga lista de propiedades no tener alineaci贸n horizontal representa un problema para la lectura, pero en realidad cuando esto sucede el problema es la que la lista sea tan larga y no su falta de alineaci贸n.

馃嵖 驴C贸mo ayuda el indentado a mejorar el c贸digo?

Un archivo de programaci贸n representa una jerarqu铆a. Hay c贸digo que pertenece al nivel mas inferior del archivo, a la clase, a los m茅todos, a condicionales y loops de este y as铆 sucesivamente.

Cada uno de estos niveles representa una jerarqu铆a distinta, y requiere por ello que esta jerarqu铆a este representa por un nivel mayor de indentado. Los programadores al leer el c贸digo dependen enormemente de un buen indentado para poder interpretar dicho c贸digo de forma correcta.

馃嵖 驴Por qu茅 establecer reglas de formateado de c贸digo para un equipo de trabajo?

Cada programador tiene sus propias predilecciones al momento de escribir c贸digo, sin embargo cuando formas parte de un equipo estas reglas cambian.

Como equipo lo ideal es formar un consenso de formato del c贸digo y apegarse a este para mantener una consistencia a trav茅s de la construcci贸n del software.

Un software bien construido esta formado de una serie de archivos que pueden leerse de forma correcta, consistente y fluida. El formateado de un archivo debe por tanto ser igual que en el resto de los que componen el programa.

Comentarios dentro del c贸digo
comments powered by Disqus