DotMDMarkdownにコメントを。気になる箇所に直接。
<!-- コメント --> は、表示されたMarkdownページでは文章を隠し、ファイルには残します。DotMDでは、文・段落・表の行につけたコメントをファイルの外に保存するので、Markdownはきれいなままです。
macOS 14以降。閲覧は無料で、編集とレビューは1回のお支払いです。
要点
Markdownファイルの中にコメントを書くには、HTMLコメント<!-- note -->を使います。レンダリングすると表示されませんが、ファイルには残ります。ファイルに手を加えずに箇所へコメントするには、DotMDで選択して⌥⌘Mを押します。コメントはその行に紐づき、ファイルではなくDotMDが保管します。エージェントに送っても、自分用のメモにしても構いません。
Markdownのコメントの書き方
Markdownには専用のコメント構文がなく、HTMLのものを使います。<!-- と --> の間はすべてコメントで、1行でも複数行でも書けます。
<!-- 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のボタンが現れます。変更が要らないコメントは、自分で解決済みにできます。
エージェントが動きやすいコメントの書き方
同僚に指示するつもりで、何が問題で、代わりにどうしてほしいかを書きます。具体的なメモなら、具体的な修正が返ってきます。
「あいまいです。3つの指標としきい値を挙げてください。」
「ここを直して」だけより、ずっと効果があります。準備ができたら、Reviewパネルにはコメントを渡す方法が2つあります。エージェントがファイルを送って待っている場合は、Sendをクリックします。そうでなければ、Copyで用意されたプロンプトをコピーして、エージェントに貼り付けます。エージェントが何をしたかの確認方法は次のガイドで説明します。
エージェントからのコメント
コメントは双方向です。DotMDでファイルのレビューをエージェントに頼むと、チャットで答える代わりに、該当する行に指摘を残します。指摘は同じパネルのOpenに、エージェントの名前と専用の色の点つきで表示されるので、Claude CodeとCodexをひと目で見分けられます。書き手に渡る前に、編集、削除、解決ができます。一連の流れはあるエージェントが別のエージェントをレビューで紹介しています。
コメントの保存場所
- ファイルではなくDotMDに保存。MarkdownにはマーカーもHTMLコメントも入らず、ほかのアプリからはファイルが元のままに見えます。
- 箇所についていく。上に行が追加されると、コメントの行番号もテキストと一緒に動きます。
- ファイルについていく。DotMDで名前を変えたり移動したりすると、コメントも一緒に移ります。Finderや
git mvで変えた場合は、新しい場所でファイルを初めて開いたときに戻ってきます。 - ファイルがなくなって1か月後まで。削除したファイルのコメントは、約1か月後にバージョン履歴とともに削除されます。
DotMDのコメントについてのよくある質問
コメントは.mdファイルに保存されますか？
いいえ。コメントはDotMDが保持するので、ファイルにマーカーやHTMLコメントは入らず、ほかのアプリからは元のままに見えます。
エージェントなしでもコメントできますか？
はい。下書きへの自分用のメモとして使えます。
ファイルの名前を変えたり移動したりするとどうなりますか？
DotMDで名前を変えると、コメントも一緒に移ります。Finderやgitで名前を変えた場合は、新しい場所でファイルを初めて開いたときに戻ります。
コメントにはDotMD Reviewerが必要ですか？
はい。コメントとレビューはDotMD Reviewer（$39.99の買い切り）に含まれます。閲覧は無料です。