為 Markdown 加註解,就加在那一段上。

在渲染後的 .md 檔中,可對一個句子、一個段落或表格的一列留下註解。這不是用 <!-- --> 隱藏文字:註解會綁在該段落上,你的 Markdown 也保持乾淨。

需要 macOS 14 或以上版本。閱讀免費;DotMD Pro 提供 3 天免費試用。

快速解答

在渲染後的頁面或編輯器中選取文字,按下 ⌥⌘M。該段會標上黃色,註解則綁定在它的行上。註解由 DotMD 保存,不在檔案裡,所以你的 Markdown 保持乾淨。可以送給代理,也可以留作自己的筆記。

如何為 Markdown 檔案加註解

註解是對某一段的備註:一個句子、一個段落、表格的一列或清單的一項。每一次審閱都從它開始,沒有代理也能使用。

  1. 選取該段

    在渲染後的頁面上選取文字;如果正在編輯,則在編輯器中選取。

  2. 開始註解

    按一下選取範圍旁的 Comment、按下 ⌥⌘M,或選擇 Edit → Add Comment…。

  3. 寫下要修改的內容

    輸入你的備註,然後按下 ⌘↩。頁面上該段會變成黃色。在交給任何人之前,你可以留下任意多則註解。

@DotMD 頁面上的一份規格:一段以黃色標示,右側的 Review 面板列出它的註解,每則都有留言者名稱與行號
以黃色標示的段落,以及它在 Review 面板中的註解。

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 註解,其他 App 看到的檔案維持原樣。
  • 跟著它的段落。上方新增行時,註解的行號會隨文字一起移動。
  • 跟著檔案。在 DotMD 中重新命名或移動檔案,註解會一起移動。在 Finder 或用 git mv 重新命名或移動,則會在你第一次於新位置開啟檔案時回來。
  • 檔案消失後保留一個月。已刪除檔案的註解約在一個月後移除,連同它的版本記錄。

關於 DotMD 註解的常見問題

註解會存進 .md 檔案嗎?

不會。註解由 DotMD 保存,所以檔案裡沒有標記或 HTML 註解,其他 App 看到的檔案維持原樣。

沒有代理也能加註解嗎?

可以,當作草稿上給自己的筆記。

如果我重新命名或移動檔案會怎樣?

在 DotMD 中重新命名,註解會跟著走。在 Finder 或 git 中重新命名,則會在你第一次於新位置開啟檔案時回來。

加註解需要 DotMD Pro 嗎?

需要。註解與審閱屬於 DotMD Pro:年訂閱附 3 天免費試用,或 Lifetime。閱讀則免費。

更多問題