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 один раз. Чтение бесплатно.