DotMDКоментарі в Markdownпросто на потрібному місці.
<!-- коментар --> ховає текст на відрендереній сторінці Markdown, але лишає його у файлі. DotMD додає коментарі до речення, абзацу чи рядка таблиці, які зберігаються поза файлом, тож ваш Markdown лишається чистим.
macOS 14 або новіша. Читати можна безкоштовно; редагування й рев'ю оплачуються один раз.
Коротко
У Markdown коментар усередині файлу — це HTML-коментар: <!-- note -->. Під час відображення його не видно, але він лишається у файлі. Щоб прокоментувати фрагмент, не чіпаючи файл, виділіть його в DotMD і натисніть ⌥⌘M. Коментар лишається прив’язаним до своїх рядків, а зберігає його DotMD, не файл. Надішліть його агентові або залиште як нотатку для себе.
Синтаксис коментарів у Markdown
У Markdown немає власного синтаксису коментарів, він бере його з HTML. Усе між <!-- і --> — коментар, в одному рядку чи в кількох:
<!-- A note to myself -->
<!--
A longer note
across several lines
-->
Text before <!-- an inline note --> and after.Відрендерена сторінка коментар не показує, але у файлі він лишається: будь-хто, хто відкриє вихідний текст, його прочитає, тому не пишіть у ньому паролі й особисті нотатки. Не ставте -- усередині коментаря. GitHub ховає такі коментарі так само.
Як залишити коментар до Markdown-файлу
Коментар — це нотатка до уривка: речення, абзацу, рядка таблиці чи пункту списку. З нього починається кожне рев’ю, і він працює навіть без агента.
-
Виділіть уривок
Виділіть текст на відрендереній сторінці або, якщо редагуєте, в редакторі.
-
Почніть коментар
Натисніть Comment поруч із виділенням, натисніть ⌥⌘M або виберіть Edit → Add Comment….
-
Напишіть, що треба змінити
Введіть нотатку й натисніть ⌘↩. Уривок на сторінці стане жовтим. Залиште стільки коментарів, скільки потрібно, перш ніж комусь їх передавати.
Панель Review: Open, In Review, Resolved
Кнопка Review на панелі інструментів відкриває праворуч панель, де кожен коментар до файлу показано карткою. На картці видно, хто залишив коментар, коли, на якому він рядку й до якого уривка належить. Натисніть картку, і сторінка прокрутиться до уривка.
| Розділ | Що в ньому |
|---|---|
| Open | Коментарі, якими ще ніхто не займався |
| In Review | Коментарі, які агент вважає виправленими й які чекають, поки ви їх приймете або відкриєте знову |
| Resolved | Готово: прийняті або закриті вами |
Наведіть курсор на картку, і з’являться її кнопки: Expand, Edit, Resolve, Accept, Reopen і Delete. Коментар, якому не потрібні зміни, закрийте самі.
Пишіть коментарі, за якими агент може діяти
Пишіть коментар так, як ставили б завдання колезі: що не так і що ви хочете натомість. Точна нотатка дає точне виправлення.
«Надто розпливчасто: назвіть три метрики та їхні пороги».
Це працює краще, ніж «виправ це». Коли будете готові, у панелі Review є два способи передати коментарі. Якщо агент надіслав вам файл і чекає, натисніть Send. Якщо ні, скопіюйте готовий промпт кнопкою Copy і вставте його агентові. У наступному посібнику показано, як перевірити, що він зробив.
Коментарі від агентів
Коментарі працюють в обидва боки. Попросіть агента перевірити файл у DotMD, і він залишить зауваження на тих рядках, яких вони стосуються, замість відповіді в чаті. Вони з’являться в тій самій панелі в розділі Open, з ім’ям агента та його власною кольоровою цяткою, тож Claude Code і Codex розрізняються з першого погляду. Ви можете редагувати, видаляти чи закривати їх, поки автор нічого не побачив. Один агент перевіряє іншого показує весь цикл.
Де зберігаються коментарі
- У DotMD, а не у файлі. У вашому Markdown немає ні маркерів, ні HTML-коментарів, і інші застосунки бачать файл таким, яким він був.
- На своєму уривку. Коли вище додаються рядки, номер рядка коментаря зсувається разом із його текстом.
- Разом із файлом. Перейменуйте або перемістіть його в DotMD, і коментарі переїдуть разом із ним. Перейменуйте або перемістіть його у Finder чи через
git mv, і вони повернуться, коли ви вперше відкриєте файл на новому місці. - Місяць після зникнення файлу. Коментарі видаленого файлу стираються приблизно через місяць разом з історією його версій.
Запитання про коментарі в DotMD
Чи зберігаються коментарі в .md-файлі?
Ні. Їх зберігає DotMD, тож у файлі немає ні маркерів, ні HTML-коментарів, а інші застосунки бачать його таким, яким він був.
Чи можна коментувати без агента?
Так, як нотатки для себе до чернетки.
Що буде, якщо перейменувати або перемістити файл?
Якщо перейменувати в DotMD, коментарі переїдуть разом із файлом. Якщо перейменувати у Finder чи в git, вони повернуться, коли ви вперше відкриєте файл на новому місці.
Чи потрібен DotMD Reviewer, щоб коментувати?
Так. Коментарі й рев'ю входять до DotMD Reviewer, $39.99 один раз. Читати безкоштовно.