Documentación de Código con CodeStream: Uso de Codemarks y Tags

¿Qué son los Codemarks y cómo nos ayudan?

Los Codemarks son una herramienta esencial para facilitar las conversaciones informales y eficientes sobre el código. No sólo permiten anotar sobre el código directamente, sino que también sirven para la creación automática de documentación compartible, asegurando que esta documentación evolucione al ritmo del código mismo. El uso de Codemarks en tu equipo y organización garantiza que la información nunca quede obsoleta, gracias a su capacidad de adaptación ante cualquier modificación en el código.

¿Cómo podemos utilizar y gestionar los Codemarks?

Existen diversas maneras de gestionar la información de manera efectiva mediante Codemarks:

1. Relaciones entre Codemarks:
   • Asociar varios Codemarks entre sí.
   • Agregar etiquetas o "tags" para identificar temas comunes.
   • Incluir varios bloques de código en un solo Codemark.

Podemos relacionar múltiples Codemarks para entender cómo diferentes secciones de código están conectadas. También es posible etiquetarlos para clasificarlos según ciertas temáticas, ayudando a agilizar búsquedas futuras.

¿Cómo se incluye más de un bloque de código en un Codemark?

Pueden integrarse múltiples bloques en un solo Codemark cuando un comentario aplica a distintas secciones. Para hacerlo, después de identificar y seleccionar el bloque de código pertinente, el usuario debe:

• Hacer clic en "add code block".
• Seleccionar el siguiente bloque de código relevante en otro archivo.
• Confirmar haciendo clic en "ok".

Esto es de gran utilidad cuando hay elementos que se repiten en distintos contextos o archivos y requieren la misma anotación.

¿Cómo creamos relaciones entre Codemarks?

Para relacionar Codemarks, simplemente accede al ícono de Codestream y busca los Codemarks que tengan alguna conexión. Una vez identificado, al hacer clic, el color cambiará para indicar que están interconectados, mostrando el nuevo status bajo el subtítulo "related".

¿Cómo usamos las etiquetas en los Codemarks?

Las etiquetas permiten clasificar y organizar eficientemente nuestros Codemarks. Taggear Codemarks con un estándar o tema específico facilita búsquedas rápidas y precisas. Para etiquetar:

• Crea y nombra la etiqueta.
• Guárdala y aplícala a todos los Codemarks relevantes.
• Utiliza filtros de búsqueda para acceder a todos los Codemarks que comparten esta etiqueta.

¿Qué ocurre si el código cambia?

Una de las ventajas fundamentales de los Codemarks es su adaptabilidad a los cambios en el código:

• Reubicación: Si un bloque de código es movido, el Codemark se desplaza automáticamente con él.
• Modificaciones: Cuando el código bajo un Codemark es editado, aparece una indicación señalando el cambio. El usuario puede decidir si agrega un nuevo comentario o actualiza el existente.

¿Cómo exportamos información de Codemarks?

Codemarks también facilita la exportación de información a otros sistemas, ampliando las posibilidades de documentación y colaboración.

¿Qué es un Permalink?

Los Permalinks son herramientas que permiten conectar un fragmento de código con otro documento externo. Selecionando el código adecuado, puedes crear un enlace (público o privado) e integrarlo en otras plataformas, como Google Docs, enriqueciendo así la documentación colaborativa.

¿Cómo exportamos Codemarks?

Para transformar los Codemarks en documentos manejables en otros sistemas, exporta los datos en formato CSV. Esta función te permite mover la documentación a plataformas como Excel o Google Sheets, facilitando su manipulación y uso en otros contextos.

Al concluir esta clase, tendremos una comprensión más clara de cómo los Codemarks no sólo anotan, sino que fortalecen la documentación colaborativa en el desarrollo de software. La capacidad de actualizarlos y exportarlos según necesitemos hace que trabajar en equipo sea más eficiente y productivo.