Markdown Inline Review
Comment trên preview Markdown theo kiểu Google Docs (bôi đen → comment, rê chuột vào đoạn đã tô để xem và sửa comment).
Comment được ghi ngay trong file .md bằng cú pháp CriticMarkup, nên Claude (hay bất kỳ ai đọc file) thấy ngay chỗ cần sửa và sửa được.
Sau khi cài: mở file .md, bấm nút 💬 trên thanh tab, bôi đen, bấm 💬 Comment.
Cú pháp lưu trong file
| Dạng |
Ý nghĩa |
{==đoạn được tô==}{>>comment<<} |
comment gắn với đoạn được tô |
{>>comment<<} đứng riêng một dòng |
comment cho khối ngay trước nó (khối mã, bảng, ảnh) |
Ví dụ: Câu này {==hơi dài==}{>>viết ngắn lại<<} nên khó đọc.
Cách dùng
- Mở file
.md: file mở thẳng ở chế độ Review (extension đăng ký là editor mặc định cho *.md).
Muốn xem/sửa mã nguồn: nút Open Markdown Source ở góc phải tab, hoặc chuột phải file → Open With… → Text Editor.
Đang ở text editor muốn quay lại Review: nút 💬 trên tab, Ctrl+Alt+V, hoặc chuột phải → Open in Review Mode.
Muốn .md mặc định mở bằng text editor như cũ: thêm vào settings "workbench.editorAssociations": { "*.md": "default" } (vẫn mở Review được bằng nút 💬).
- Bôi đen văn bản trong preview, bấm
💬 Comment, gõ nội dung, bấm Comment (hoặc Ctrl+Enter).
- Rê chuột vào đoạn đã tô: popover hiện nội dung comment với
Edit và Resolve (xoá marker, giữ văn bản). Bấm vào đoạn đã tô để sửa ngay.
- Nhờ Claude xử lý: nói "xử lý các review comment trong file X", hoặc chạy lệnh
Markdown Review: Copy Comments as Claude Prompt rồi dán vào Claude Code.
Trong preview mặc định của VS Code (Ctrl+Shift+V / Ctrl+K V) cũng làm được y hệt: bôi đen → 💬 Comment, rê chuột vào đoạn đã tô → popover Edit/Resolve.
Lần đầu VS Code hỏi "Allow 'Markdown Inline Review' extension to open this URI?": tick "Do not ask me again for this extension" rồi Open.
Lý do: preview mặc định không cho extension ngoài kênh nhắn tin, nên script gửi yêu cầu qua link vscode://PhanHoaiNam.md-review-comments/....
Nếu bôi đen bằng double-click mà bị nhảy sang editor, tắt markdown.preview.doubleClickToSwitchToEditor.
Trong editor văn bản: bôi đen rồi Ctrl+Alt+M để comment không cần mở preview.
Trong editor, đoạn được tô và comment được tô màu, rê chuột thấy nội dung comment.
File được tự lưu sau khi thêm/sửa/xoá comment nếu trước đó không có thay đổi chưa lưu, để Claude đọc được bản mới nhất.
Quy tắc cho Claude
Thêm đoạn sau (có sẵn trong file claude-rule.md của dự án này) vào CLAUDE.md global hoặc của dự án, để Claude tự biết cách xử lý comment:
## Review comment trong file Markdown
File `.md` có thể chứa comment review (tạo bằng extension Markdown Inline Review) theo cú pháp:
- `{==đoạn được tô==}{>>comment<<}`: comment về đoạn được tô.
- `{>>comment<<}` đứng riêng một dòng: comment về khối ngay trước nó (đoạn văn, khối mã, bảng).
Khi được yêu cầu xử lý comment trong một file: sửa nội dung theo từng comment, rồi xoá toàn bộ marker (`{==`, `==}`, `{>>…<<}`) nhưng giữ lại văn bản đã sửa.
Không tự thêm comment mới, không để sót marker, không sửa chỗ không có comment.
Nếu file có comment nhưng không được yêu cầu xử lý: giữ nguyên marker và báo cho người dùng biết file còn bao nhiêu comment.
Giới hạn
- Bôi đen trong khối mã: comment được đặt riêng ngay sau khối, kèm trích dẫn đoạn chọn (
{>>re "…": comment<<}).
- Không nhận khối mã thụt lề 4 khoảng trắng (chỉ nhận ``` và ~~~).
- HTML thô trong file được render, nhưng script bị chặn bởi CSP của webview.
Build
npm install
npm test # unit test (node --test)
npm run package # tạo md-review-comments-<version>.vsix
code --install-extension md-review-comments-<version>.vsix
Kiểm thử giao diện ngoài VS Code: node test-ui/build-harness.js <out.html> rồi mở file đó qua một HTTP server (node test-ui/serve.js <thư mục> 8765).