Sintaxis y guía de diseño del diagrama de paquetes de Mermaid.js

Un diagrama de paquetes es un componente de visualización especializado utilizado por ingenieros de redes, analistas de seguridad y desarrolladores de sistemas para representar la estructura binaria exacta de protocolos de red, asignaciones de memoria o encabezados de paquetes de hardware personalizados. Introducido nativamente en Mermaid.js, esta herramienta reemplaza el tedioso dibujo manual de tablas al renderizar automáticamente un mapa de cuadrícula a nivel de bits, adaptable y perfectamente alineado, a partir de una descomposición de campos limpia y basada en texto.

Comprender la disposición de la cuadrícula de paquetes

A diferencia de los diagramas de flujo libres estándar, un diagrama de paquetes depende de un sistema estricto y matemático de cuadrícula modelado directamente según los RFC de redes:

  • Ancho de bits (eje horizontal): El motor de diseño segmenta automáticamente cada fila en un sistema de cuadrícula de 32 bits (que abarca los bits 0 a 31) de forma predeterminada.
  • Cálculo automático de bits: Simplemente declara el tamaño en bits para cada campo. El motor de renderizado se encarga de las operaciones matemáticas: empaqueta automáticamente los campos adyacentes en la misma fila o los envuelve limpiamente a la siguiente fila cuando el tamaño acumulado supera el umbral de 32 bits.

Estructura básica de sintaxis

Cada mapa de paquetes comienza con el packet encabezado de declaración. A continuación se declaran campos en bloques como pares secuenciales que coinciden con un patrón estricto de"Nombre del campo": TamañoEnBits patrón en líneas individuales.

packet
  0-3: "Versión"
  4-7: "IHL"
  8-15: "Tipo de servicio"
  16-31: "Longitud total"

Referencia de sintaxis

La tabla a continuación desglosa los parámetros de datos fundamentales y las reglas de formato de diseño necesarias para construir un diagrama de paquetes en Mermaid.js.

Elemento de sintaxis Requisito de tipo Descripción y comportamiento visual de la cuadrícula
Declaración Identificador de palabra clave Inicializa el entorno de trabajo de diseño de protocolo a nivel de bits. Debe usar exactamente el packet bloque de encabezado.
Nombre del campo Cadena entre comillas La etiqueta que se muestra dentro del espacio del bloque. Siempre debe ir entre comillas dobles.
Tamaño de bit Entero positivo La longitud absoluta de bits del campo (por ejemplo, 1 para banderas de un solo bit, 8 para bytes, 16 para shorts). Establece el ancho visual.
Disparador de salto de fila Seguimiento automático Ocurre automáticamente cada vez que la suma total de tamaños de bits alcanza un múltiplo de 32 bits.

Plano del mundo real: Mapa estructural del encabezado de paquete IPv4

Este plano completo rastrea la estructura estándar de un paquete de enrutamiento de internet (IPv4). Muestra cómo los campos de varios bits, las banderas de un solo bit y los bloques más grandes de 16 bits se ensamblan secuencialmente dentro de la disposición estándar de cuadrícula horizontal de 32 bits. Los campos que alcanzan la marca de 32 bits caen automáticamente y limpiamente a la siguiente fila.

paquete
  0-3: "Versión"
  4-7: "IHL"
  8-15: "Tipo de servicio"
  16-31: "Longitud total"
  32-47: "Identificación"
  48-50: "Banderas"
  51-63: "Desplazamiento de fragmento"
  64-71: "TTL"
  72-79: "Protocolo"
  80-95: "Verificación de encabezado"


Consejo de sintaxis: Si un campo declarado individualmente es mayor que 32 bits (por ejemplo, una sal criptográfica de 64 bits o una marca de tiempo), el motor de renderizado envolverá y estirará suavemente ese bloque verticalmente a través de múltiples filas consecutivas, utilizando indicadores de conexión limpios para preservar la legibilidad.


Errores comunes de sintaxis y limitaciones del sistema

Al diseñar mapas de documentación de nivel de byte altamente precisos, tenga en cuenta estos parámetros de solución de problemas para evitar errores de compilación:

  • Envoltorios obligatorios de comillas: Cada cadena de texto del descriptor de campo debe ir entre comillas dobles. Omitir los corchetes de comillas provocará errores inmediatos de análisis sintáctico.
  • Tamaños de bits de cadena no válidos: La asignación de grosor de valor que sigue al separador de dos puntos debe ser un entero sin comillas. Pasar decimales o tamaños alfabéticos (por ejemplo, "Datos": 8bits) detendrá la compilación del diagrama.
  • Alineación de borde de cuadrículaAsegúrese de que la suma total de sus campos combinados sea un múltiplo limpio de 32 si desea diagramas de encabezado uniformes y con forma de caja. Dejar una fila con bits no asignados al final puede causar bloques finales con aspecto desigual.
  • Restricciones de vista de escala:Aunque el motor calcula dinámicamente los anchos de diseño, meter descripciones de texto extremadamente largas en bloques pequeños de 1 bit o 2 bits puede cortar la tipografía o causar congestión visual. Mantenga las etiquetas de bits pequeños breves.
Scroll al inicio