DotMDKomentáře v Markdownupřímo u pasáže.
<!-- komentář --> skryje text na vykreslené stránce Markdownu, ale ponechá ho v souboru. DotMD přidává komentáře k větě, odstavci nebo řádku tabulky, které zůstávají mimo soubor, takže váš Markdown zůstává čistý.
macOS 14 nebo novější. Čtení je zdarma; úpravy a revize se platí jednou.
Rychlá odpověď
V Markdownu je komentář uvnitř souboru HTML komentář: <!-- note -->. Po vykreslení není vidět, ale v souboru zůstává. Chcete-li pasáž okomentovat, aniž byste soubor měnili, označte ji v DotMD a stiskněte ⌥⌘M. Komentář zůstává svázaný se svými řádky a uchovává ho DotMD, ne soubor. Pošlete ho agentovi, nebo si ho nechte jako poznámku pro sebe.
Syntaxe komentářů v Markdownu
Markdown nemá vlastní syntaxi komentářů a půjčuje si ji z HTML. Vše mezi <!-- a --> je komentář, na jednom řádku i na více:
<!-- A note to myself -->
<!--
A longer note
across several lines
-->
Text before <!-- an inline note --> and after.Vykreslená stránka komentář vynechá, ale v souboru zůstává: kdo otevře surový text, přečte si ho, takže do něj nepište hesla ani soukromé poznámky. Neuvádějte uvnitř komentáře --. GitHub tyto komentáře skrývá stejně.
Jak okomentovat soubor Markdown
Komentář je poznámka k pasáži: větě, odstavci, řádku tabulky nebo položce seznamu. Od něj se odvíjí každá revize a funguje i bez agenta.
-
Označte pasáž
Označte text na vykreslené stránce, nebo v editoru, pokud upravujete.
-
Začněte komentář
Klikněte na Comment vedle výběru, stiskněte ⌥⌘M, nebo zvolte Edit → Add Comment….
-
Napište, co se má změnit
Napište poznámku a stiskněte ⌘↩. Pasáž se na stránce zbarví žlutě. Komentářů můžete nechat, kolik chcete, než je někomu předáte.
Panel Review: Open, In Review, Resolved
Tlačítko Review na panelu nástrojů otevře vpravo panel, kde je každý komentář k souboru jako karta. Karta ukazuje, kdo komentář napsal, kdy, na kterém řádku leží a ke které pasáži patří. Po kliknutí na kartu se stránka posune k pasáži.
| Sekce | Co v ní je |
|---|---|
| Open | Komentáře, kterými se zatím nikdo nezabýval |
| In Review | Komentáře, které agent označil za opravené a čekají, až je přijmete nebo znovu otevřete |
| Resolved | Hotovo: přijaté nebo vyřešené vámi |
Najeďte na kartu a objeví se její tlačítka: Expand, Edit, Resolve, Accept, Reopen a Delete. Komentář, který nevyžaduje změnu, vyřešte sami.
Pište komentáře, podle kterých agent může jednat
Napište komentář tak, jako byste zadávali práci kolegovi: co je špatně a co chcete místo toho. Přesná poznámka vede k přesné opravě.
„Příliš vágní: uveďte tři metriky a jejich prahové hodnoty.“
To funguje lépe než „oprav to“. Až budete připraveni, panel Review nabízí dva způsoby, jak komentáře předat. Pokud vám agent poslal soubor a čeká, klikněte na Send. Jinak zkopírujte hotový prompt tlačítkem Copy a vložte ho agentovi. Další průvodce ukazuje, jak zkontrolovat, co udělal.
Komentáře od agentů
Komentáře jdou oběma směry. Požádejte agenta, aby soubor v DotMD zrevidoval, a on nechá poznámky u řádků, kterých se týkají, místo odpovědi v chatu. Objeví se ve stejném panelu v sekci Open se jménem agenta a jeho vlastní barevnou tečkou, takže Claude Code od Codexu poznáte na první pohled. Můžete je upravit, smazat nebo vyřešit, než je uvidí autor. Jeden agent kontroluje druhého ukazuje celý postup.
Kde se komentáře uchovávají
- V DotMD, ne v souboru. V Markdownu nejsou žádné značky ani HTML komentáře a ostatní aplikace vidí soubor tak, jak byl.
- U své pasáže. Když se nad komentářem přidají řádky, číslo řádku komentáře se posune spolu s textem.
- Se souborem. Přejmenujete-li soubor nebo ho přesunete v DotMD, komentáře se přesunou s ním. Přejmenujete-li ho nebo přesunete ve Finderu či pomocí
git mv, vrátí se při prvním otevření souboru na novém místě. - Měsíc po zmizení souboru. Komentáře smazaného souboru se odstraní zhruba po měsíci, spolu s jeho historií verzí.
Otázky ke komentářům v DotMD
Ukládají se komentáře do souboru .md?
Ne. Uchovává je DotMD, takže soubor neobsahuje žádné značky ani HTML komentáře a ostatní aplikace ho vidí tak, jak byl.
Mohu komentovat bez agenta?
Ano, jako poznámky pro sebe k rozpracovanému textu.
Co se stane, když soubor přejmenuji nebo přesunu?
Při přejmenování v DotMD se komentáře přesunou s ním. Při přejmenování ve Finderu nebo v gitu se vrátí při prvním otevření souboru na novém místě.
Potřebuji DotMD Reviewer ke komentování?
Ano. Komentáře a revize patří do DotMD Reviewer, $39.99 jednou. Čtení je zdarma.