DotMDKomentarze w Markdown,dokładnie przy fragmencie.
<!-- komentarz --> ukrywa tekst na wyrenderowanej stronie Markdown, ale zostawia go w pliku. DotMD dodaje komentarze do zdania, akapitu lub wiersza tabeli, które zostają poza plikiem, więc Twój Markdown pozostaje czysty.
macOS 14 lub nowszy. Czytanie jest bezpłatne; edycja i przeglądy to jednorazowa płatność.
Krótka odpowiedź
W Markdown komentarz w pliku to komentarz HTML: <!-- note -->. Po wyrenderowaniu jest niewidoczny, ale zostaje w pliku. Aby skomentować fragment bez ruszania pliku, zaznacz go w DotMD i naciśnij ⌥⌘M. Komentarz pozostaje powiązany ze swoimi wierszami, a przechowuje go DotMD, nie plik. Wyślij go agentowi albo zostaw jako notatkę dla siebie.
Składnia komentarzy w Markdown
Markdown nie ma własnej składni komentarzy i korzysta ze składni HTML. Wszystko między <!-- a --> jest komentarzem, w jednej linii lub w kilku:
<!-- A note to myself -->
<!--
A longer note
across several lines
-->
Text before <!-- an inline note --> and after.Wyrenderowana strona pomija komentarz, ale zostaje on w pliku: każdy, kto otworzy surowy tekst, może go przeczytać, więc nie wpisuj tam haseł ani prywatnych notatek. Nie pisz -- wewnątrz komentarza. GitHub ukrywa takie komentarze tak samo.
Jak skomentować plik Markdown
Komentarz to notatka do fragmentu: zdania, akapitu, wiersza tabeli lub punktu listy. Od niego zaczyna się każdy przegląd i działa też zupełnie bez agenta.
-
Zaznacz fragment
Zaznacz tekst na wyrenderowanej stronie albo w edytorze, jeśli właśnie edytujesz.
-
Zacznij komentarz
Kliknij Comment obok zaznaczenia, naciśnij ⌥⌘M albo wybierz Edit → Add Comment….
-
Napisz, co ma się zmienić
Wpisz notatkę i naciśnij ⌘↩. Fragment robi się żółty na stronie. Zostaw tyle komentarzy, ile chcesz, zanim komukolwiek je przekażesz.
Panel Review: Open, In Review, Resolved
Przycisk Review na pasku narzędzi otwiera po prawej panel, w którym każdy komentarz do pliku jest kartą. Karta pokazuje, kto zostawił komentarz, kiedy, w którym wierszu leży i czego dotyczy. Kliknij kartę, a strona przewinie się do fragmentu.
| Sekcja | Co w niej jest |
|---|---|
| Open | Komentarze, którymi nikt jeszcze się nie zajął |
| In Review | Komentarze, które agent uznał za poprawione i które czekają, aż je zaakceptujesz lub otworzysz ponownie |
| Resolved | Załatwione: zaakceptowane albo rozwiązane przez Ciebie |
Najedź na kartę, a pojawią się jej przyciski: Expand, Edit, Resolve, Accept, Reopen i Delete. Komentarz, który nie wymaga zmiany, rozwiąż sam.
Pisz komentarze, z którymi agent coś zrobi
Napisz komentarz tak, jakbyś wprowadzał w temat kolegę: co jest nie tak i czego chcesz w zamian. Dokładna notatka daje dokładną poprawkę.
„Zbyt ogólnie: podaj trzy metryki i ich progi.”
Działa to lepiej niż „popraw to”. Gdy będziesz gotowy, panel Review daje dwa sposoby przekazania komentarzy. Jeśli agent przysłał Ci plik i czeka, kliknij Send. W przeciwnym razie skopiuj gotowy prompt przyciskiem Copy i wklej go agentowi. Następny poradnik pokazuje, jak sprawdzić, co zrobił.
Komentarze od agentów
Komentarze idą w obie strony. Poproś agenta o przegląd pliku w DotMD, a zostawi uwagi przy wierszach, których dotyczą, zamiast odpowiadać na czacie. Pojawiają się w tym samym panelu w sekcji Open, z nazwą agenta i jego własną kolorową kropką, więc Claude Code od Codexa odróżnisz od razu. Możesz je edytować, usuwać lub rozwiązywać, zanim autor cokolwiek zobaczy. Jeden agent sprawdza drugiego pokazuje całą pętlę.
Gdzie są przechowywane komentarze
- W DotMD, nie w pliku. W Twoim Markdownie nie ma znaczników ani komentarzy HTML, a inne aplikacje widzą plik takim, jaki był.
- Przy swoim fragmencie. Gdy wyżej dodawane są wiersze, numer wiersza komentarza przesuwa się razem z jego tekstem.
- Razem z plikiem. Zmień nazwę pliku lub przenieś go w DotMD, a komentarze pójdą za nim. Zmień nazwę lub przenieś go w Finderze albo przez
git mv, a wrócą przy pierwszym otwarciu pliku w nowym miejscu. - Miesiąc po zniknięciu pliku. Komentarze usuniętego pliku są kasowane mniej więcej po miesiącu, razem z jego historią wersji.
Pytania o komentarze w DotMD
Czy komentarze są zapisywane w pliku .md?
Nie. Przechowuje je DotMD, więc w pliku nie ma znaczników ani komentarzy HTML, a inne aplikacje widzą go takim, jaki był.
Czy mogę komentować bez agenta?
Tak, jako notatki dla siebie do szkicu.
Co się stanie, gdy zmienię nazwę pliku lub go przeniosę?
Po zmianie nazwy w DotMD komentarze idą z plikiem. Po zmianie nazwy w Finderze lub w git wracają przy pierwszym otwarciu pliku w nowym miejscu.
Czy potrzebuję DotMD Reviewer, żeby komentować?
Tak. Komentarze i przeglądy są częścią DotMD Reviewer, $39.99 jednorazowo. Czytanie jest bezpłatne.