Comentarios en Markdownjusto en el pasaje.

<!-- comentario --> oculta texto en la página Markdown renderizada y lo mantiene en el archivo. DotMD añade comentarios sobre una frase, un párrafo o una fila de tabla que quedan fuera del archivo, así que tu Markdown sigue limpio.

macOS 14 o posterior. Leer es gratis; editar y revisar se pagan una sola vez.

Respuesta rápida

En Markdown, un comentario dentro del archivo es un comentario HTML: <!-- note -->. Al renderizar queda oculto, pero sigue en el archivo. Para comentar un pasaje sin tocar el archivo, selecciónalo en DotMD y pulsa ⌥⌘M. El comentario queda unido a sus líneas y lo guarda DotMD, no el archivo. Envíalo a un agente o guárdalo como nota para ti.

Sintaxis de los comentarios en Markdown

Markdown no tiene una sintaxis de comentarios propia y usa la de HTML. Todo lo que hay entre <!-- y --> es un comentario, en una línea o en varias:

<!-- A note to myself -->

<!--
A longer note
across several lines
-->

Text before <!-- an inline note --> and after.

La página renderizada omite el comentario, pero sigue en el archivo: quien abra el texto sin procesar puede leerlo, así que no pongas contraseñas ni notas privadas. No escribas -- dentro de un comentario. GitHub oculta estos comentarios igual.

Cómo comentar un archivo Markdown

Un comentario es una nota sobre un pasaje: una frase, un párrafo, una fila de tabla o un elemento de lista. Es donde empieza toda revisión, y funciona sin ningún agente.

  1. Selecciona el pasaje

    Selecciona texto en la página renderizada o, si estás editando, en el editor.

  2. Empieza el comentario

    Haz clic en Comment junto a la selección, pulsa ⌥⌘M o elige Edit → Add Comment….

  3. Escribe qué debe cambiar

    Escribe tu nota y pulsa ⌘↩. El pasaje se pone amarillo en la página. Deja todos los comentarios que quieras antes de entregárselos a nadie.

@DotMD con una spec en la página: un pasaje marcado en amarillo y, a la derecha, el panel Review con sus comentarios, cada uno con el nombre de quien lo dejó y su línea
Un pasaje marcado en amarillo y sus comentarios en el panel Review.

El panel Review: Open, In Review, Resolved

El botón Review de la barra de herramientas abre a la derecha un panel con cada comentario del archivo como una tarjeta. La tarjeta muestra quién dejó el comentario, cuándo, en qué línea está y de qué pasaje trata. Haz clic en una tarjeta y la página se desplaza al pasaje.

SecciónQué contiene
OpenComentarios de los que nadie se ha ocupado todavía
In ReviewComentarios que un agente dice haber corregido y esperan a que los aceptes o los reabras
ResolvedHechos: aceptados o resueltos por ti

Pasa el cursor por una tarjeta para ver sus botones: Expand, Edit, Resolve, Accept, Reopen y Delete. Resuelve tú mismo un comentario cuando no necesite ningún cambio.

Escribe comentarios con los que un agente pueda actuar

Escribe un comentario como si dieras instrucciones a un compañero: qué está mal y qué quieres en su lugar. Una nota precisa consigue una corrección precisa.

«Demasiado vago: nombra las tres métricas y sus umbrales».

Eso funciona mejor que «arregla esto». Cuando estés listo, el panel Review te da dos formas de entregar los comentarios. Si el agente te envió el archivo y espera, haz clic en Send. Si no, copia el prompt preparado con Copy y pégaselo a tu agente. La siguiente guía muestra cómo comprobar lo que hizo.

Comentarios de agentes

Los comentarios van en las dos direcciones. Pide a un agente que revise un archivo en DotMD y dejará sus observaciones en las líneas a las que se refieren, en lugar de responder en el chat. Aparecen en el mismo panel en Open, con el nombre del agente y su propio punto de color, así que distingues Claude Code de Codex de un vistazo. Puedes editarlos, borrarlos o resolverlos antes de que el autor vea nada. Un agente revisa a otro muestra todo el ciclo.

Dónde se guardan los comentarios

  • En DotMD, no en el archivo. Tu Markdown no tiene marcas ni comentarios HTML, y otras apps ven el archivo tal como estaba.
  • En su pasaje. Cuando se añaden líneas por encima, el número de línea del comentario se mueve con su texto.
  • Con el archivo. Si lo renombras o lo mueves en DotMD, los comentarios se mueven con él. Si lo renombras o lo mueves en Finder o con git mv, vuelven la primera vez que abres el archivo en su nuevo sitio.
  • Un mes después de que el archivo desaparezca. Los comentarios de un archivo borrado se eliminan aproximadamente un mes después, junto con su historial de versiones.

Preguntas sobre los comentarios en DotMD

¿Se guardan los comentarios en el archivo .md?

No. Los guarda DotMD, así que el archivo no tiene marcas ni comentarios HTML, y otras apps lo ven tal como estaba.

¿Puedo comentar sin un agente?

Sí, como notas para ti en un borrador.

¿Qué pasa si renombro o muevo el archivo?

Si lo renombras en DotMD, los comentarios se mueven con él. Si lo renombras en Finder o en git, vuelven la primera vez que abres el archivo en su nuevo sitio.

¿Necesito DotMD Reviewer para comentar?

Sí. Los comentarios y las revisiones forman parte de DotMD Reviewer, $39.99 una vez. Leer es gratis.

Más preguntas