plegado de código

Básicamente, las aplicaciones utilizan el plegado de código para organizar el código fuente, reduciendo cada bloque a una sola línea. Esto puede aplicarse solo a bloques de nivel superior, como funciones y clases; a bloques anidados, como funciones y métodos anidados; o a todos los bloques, especialmente a los de control de flujo. Esto permite obtener una visión general del código, navegar y reorganizarlo fácilmente, y profundizar en los detalles según sea necesario, sin distracciones. En cuanto a la visualización, permite ver rápidamente una lista de todas las funciones (sin su cuerpo), mientras que en cuanto a la navegación, reemplaza la paginación extensa o la búsqueda del objetivo por la posibilidad de acceder directamente a la siguiente función.

Algunos lenguajes o bibliotecas requieren una gran cantidad de código repetitivo . Esto da como resultado un código extremadamente largo, que puede dificultar la comprensión del punto principal. Además, parte del código sustancial puede perderse entre el código repetitivo.

Por ejemplo, en Java, un único campo privado con un método getter y un método setter requiere al menos 3 líneas, si cada uno está en una línea separada:

private String nombre = null ; public String obtenerNombre ( ) { return nombre ; } public void establecerNombre ( String nombre ) { this.nombre = nombre ; }​

Esto se expande a 10 líneas con saltos de línea de función convencionales y espaciado entre funciones (incluido el salto de línea final):

cadena privada nombre = null ;public String getName () { return nombre ; }public void setName ( String name ) { this . name = name ; }

La documentación con Javadoc amplía esto a 20 líneas:

/** * Propiedad <code>name</code> legible/escribible. */ private String name = null ;/** * Método getter para la propiedad <code>name</code> */ public String getName () { return name ; }/** * Método para establecer el nombre de la propiedad <code>name</code>. * @param name */ public void setName ( String name ) { this . name = name ; }

Si existen muchos campos de este tipo, el resultado puede ser fácilmente cientos de líneas de código con muy poco contenido "interesante". El plegado de código puede reducirlo a una sola línea por campo, o incluso a una sola línea para todos los campos. Además, si se pliegan todos los campos rutinarios, pero no los campos no rutinarios (donde el método getter o setter no se limita a devolver o asignar un valor a un campo privado), resulta más fácil visualizar el código principal.

Los metadatos pueden ser extensos y, por lo general, son menos importantes que los datos que describen. La agregación de metadatos permite centrarse principalmente en los datos, no en los metadatos. Por ejemplo, una larga lista de atributos en C# se puede agregar manualmente de la siguiente manera: ^{[ 6 ]}

#region Atributos [Navegable(false)] [PropiedadFusionable(false)] [ValorPredeterminado(null)] [ModoPersistencia(ModoPersistencia.PropiedadInterior)] [ContenedorTempla(tipo(MiTipo))] [InstanciaTempla(InstanciaTempla.Única)] #endregion public ITemplate ContentTemplate { obtener ; establecer ; }

El código resultante se muestra como:

Atributos públicos ITemplate ContentTemplate { obtener ; establecer ; }

Los comentarios son una forma de metadatos legibles para humanos, y los comentarios extensos pueden interrumpir el flujo del código. Esto puede ocurrir tanto con un comentario largo para una sección corta de código, como un párrafo para explicar una línea, como con comentarios para generadores de documentación , como Javadoc o la documentación XML . El plegado de código permite incluir comentarios largos, pero mostrarlos solo cuando sea necesario. En los casos en que un comentario largo tiene una sola línea de resumen, como en las cadenas de documentación de Python, el resumen se puede seguir mostrando incluso cuando la sección está contraída, lo que permite una vista resumida y detallada.

La programación estructurada consiste en bloques de código anidados, y los bloques de código largos, como las sentencias switch largas, pueden ocultar la estructura general. El plegado de código permite ver la estructura general y expandirla a un nivel específico. Además, en algunos usos, particularmente en la programación estructurada estricta (salida de una sola función), existen patrones de código que son difíciles de ver al observar el código expandido. Por ejemplo, en la gestión de recursos en la programación estructurada, generalmente se adquiere un recurso, seguido de un bloque de código que lo utiliza y finaliza con su liberación. El par adquisición/liberación es difícil de ver si hay un bloque de código largo entre ellos, pero es fácil de ver si el bloque intermedio está plegado. De manera similar, en el código condicional if...then...else, los bloques secundarios pueden estar lejos de la sentencia de condición.

Los grupos de pliegue se pueden usar para agrupar código, ya sea mediante una agrupación explícita, similar a los bloques de comentarios que separan un módulo en secciones o a los miembros de una clase en grupos asociados, o de forma implícita, como agrupando automáticamente a los miembros de una clase por nivel de acceso.

El código heredado, o cualquier código que un desarrollador no desee ver o modificar en un momento dado, se puede ocultar para que los programadores puedan concentrarse en el código que están analizando.

Los puntos de plegado dependientes de la sintaxis son aquellos que se basan en el contenido del archivo que se está editando para especificar dónde deben comenzar y terminar las regiones de plegado. Los puntos de plegado basados ​​en la sintaxis suelen definirse en torno a una o varias de las características estándar del lenguaje de marcado o de programación en uso. Son deseables por ser automáticos y ajustarse a la estructura del código, pero su implementación puede requerir un trabajo considerable y tiempo de cálculo al editar un archivo.

Los puntos de plegado basados ​​en la indentación se especifican generalmente por la posición y la secuencia de los espacios en blanco no imprimibles, como tabulaciones y espacios, dentro del texto. Esto se utiliza con mayor frecuencia como una forma sencilla de plegado basado en la sintaxis, ya que la indentación casi siempre refleja el nivel de anidamiento en los estilos de indentación de los lenguajes de programación estructurados.

Esta convención es especialmente adecuada para sintaxis con una regla de sangría , de modo que la estructura coincide en gran medida con la sangría. Algunos ejemplos son Python y los archivos de texto que requieren sangría como regla general. Sin embargo, incluso en estos casos, la estructura no siempre coincide exactamente con la sangría, como en la continuación de línea , por lo que se prefiere el plegado dependiente de la sintaxis.

Los puntos de plegado basados ​​en tokens se especifican mediante delimitadores especiales que no tienen otra función en el texto que la de identificar los límites de dichos puntos. Esta convención se puede comparar con los puntos de plegado basados ​​en sangría, donde se utilizan caracteres imprimibles en lugar de espacios en blanco. Los tokens delimitadores más comunes son {{{para iniciar y}}} finalizar la sección plegada.

Otro token destacable son las directivas #regionde C# y las directivas #Regionde Visual Basic , utilizadas en el editor de código de Microsoft Visual Studio . Estas se tratan sintácticamente como directivas del compilador , aunque no afectan a la compilación.

Como método manual, el plegado basado en tokens permite discreción a la hora de agrupar el código en función de criterios arbitrarios, como "funciones relacionadas con una tarea determinada", que no se pueden inferir del análisis sintáctico.

El plegado basado en tokens requiere señalización interna, donde los tokens de plegado son esencialmente comentarios estructurados y, a diferencia de otros métodos, están presentes en el código fuente y son visibles para otros programadores. Esto permite compartirlos, pero también exige su uso (o conservación) por parte de todos los programadores que trabajan en un archivo en particular, lo que puede generar fricción y una mayor carga de mantenimiento.

El plegado especificado por el usuario permite plegar secciones de texto mediante un método de selección genérico, pero sin modificar el código fuente (de forma externa), sino que la configuración se especifica únicamente en el editor. Por ejemplo, un programador puede seleccionar algunas líneas de texto y especificar que se plieguen. El texto plegado puede ser anónimo o tener nombre, y esta configuración puede conservarse entre sesiones de edición o descartarse. A diferencia del plegado basado en tokens, este método no modifica el texto fuente; por lo tanto, no se comparte con otros editores del archivo y no es visible en el código.