DotMDCommentaire en Markdown,directement sur le passage.
<!-- commentaire --> masque du texte dans la page Markdown rendue et le garde dans le fichier. DotMD ajoute des commentaires sur une phrase, un paragraphe ou une ligne de tableau qui restent hors du fichier : votre Markdown reste propre.
macOS 14 ou ultérieur. La lecture est gratuite ; l’édition et les relectures se paient en une fois.
Réponse rapide
En Markdown, un commentaire dans le fichier s’écrit en HTML : <!-- note -->. Il reste invisible au rendu, mais il demeure dans le fichier. Pour commenter un passage sans toucher au fichier, sélectionnez-le dans DotMD et appuyez sur ⌥⌘M. Le commentaire reste lié à ses lignes et DotMD le conserve, pas le fichier. Envoyez-le à un agent, ou gardez-le comme note pour vous.
La syntaxe des commentaires en Markdown
Markdown n’a pas de syntaxe de commentaire propre : il emprunte celle du HTML. Tout ce qui se trouve entre <!-- et --> est un commentaire, sur une ligne ou sur plusieurs :
<!-- A note to myself -->
<!--
A longer note
across several lines
-->
Text before <!-- an inline note --> and after.La page rendue omet le commentaire, mais il reste dans le fichier : quiconque ouvre le texte brut peut le lire, n’y mettez donc ni mots de passe ni notes privées. N’écrivez pas -- dans un commentaire. GitHub masque ces commentaires de la même façon.
Comment commenter un fichier Markdown
Un commentaire est une note sur un passage : une phrase, un paragraphe, une ligne de tableau ou un élément de liste. Toute relecture commence par là, et cela fonctionne sans aucun agent.
-
Sélectionnez le passage
Sélectionnez du texte sur la page mise en forme ou, si vous modifiez, dans l’éditeur.
-
Lancez le commentaire
Cliquez sur Comment à côté de la sélection, appuyez sur ⌥⌘M ou choisissez Edit → Add Comment….
-
Écrivez ce qui doit changer
Tapez votre note et appuyez sur ⌘↩. Le passage devient jaune sur la page. Laissez autant de commentaires que vous voulez avant de les remettre à qui que ce soit.
Le panneau Review : Open, In Review, Resolved
Le bouton Review de la barre d’outils ouvre à droite un panneau où chaque commentaire du fichier est une carte. Une carte indique qui a laissé le commentaire, quand, sur quelle ligne il se trouve et de quel passage il parle. Cliquez sur une carte et la page défile jusqu’au passage.
| Section | Ce qu’elle contient |
|---|---|
| Open | Les commentaires dont personne ne s’est encore occupé |
| In Review | Les commentaires qu’un agent dit avoir corrigés, en attente que vous les acceptiez ou les rouvriez |
| Resolved | Terminé : accepté, ou résolu par vous |
Survolez une carte pour voir ses boutons : Expand, Edit, Resolve, Accept, Reopen et Delete. Résolvez vous-même un commentaire qui n’appelle aucun changement.
Écrire des commentaires exploitables par un agent
Rédigez un commentaire comme si vous briefiez un collègue : ce qui ne va pas et ce que vous voulez à la place. Une note précise donne une correction précise.
« Trop vague : nommez les trois indicateurs et leurs seuils. »
C’est plus efficace que « corrige ça ». Quand vous êtes prêt, le panneau Review offre deux façons de transmettre les commentaires. Si l’agent vous a envoyé le fichier et attend, cliquez sur Send. Sinon, copiez le prompt prêt à l’emploi avec Copy et collez-le à votre agent. Le guide suivant montre comment vérifier ce qu’il a fait.
Les commentaires des agents
Les commentaires vont dans les deux sens. Demandez à un agent de relire un fichier dans DotMD : il laisse ses remarques sur les lignes concernées au lieu de répondre dans le chat. Elles apparaissent dans le même panneau sous Open, avec le nom de l’agent et son propre point de couleur, pour distinguer Claude Code de Codex d’un coup d’œil. Vous pouvez les modifier, les supprimer ou les résoudre avant que l’auteur ne voie quoi que ce soit. Un agent relit un autre agent montre toute la boucle.
Où sont conservés les commentaires
- Dans DotMD, pas dans le fichier. Votre Markdown n’a ni marqueurs ni commentaires HTML, et les autres apps voient le fichier tel qu’il était.
- Sur leur passage. Quand des lignes sont ajoutées au-dessus, le numéro de ligne du commentaire suit son texte.
- Avec le fichier. Renommez-le ou déplacez-le dans DotMD et les commentaires suivent. Renommez-le ou déplacez-le dans le Finder ou avec
git mv, et ils reviennent la première fois que vous ouvrez le fichier à son nouvel emplacement. - Un mois après la disparition du fichier. Les commentaires d’un fichier supprimé sont effacés environ un mois plus tard, avec son historique de versions.
Questions sur les commentaires dans DotMD
Les commentaires sont-ils enregistrés dans le fichier .md ?
Non. DotMD les conserve lui-même : le fichier n’a ni marqueurs ni commentaires HTML, et les autres apps le voient tel qu’il était.
Puis-je commenter sans agent ?
Oui, comme notes pour vous sur un brouillon.
Que se passe-t-il si je renomme ou déplace le fichier ?
Renommé dans DotMD, le fichier garde ses commentaires. Renommé dans le Finder ou dans git, il les retrouve la première fois que vous l’ouvrez à son nouvel emplacement.
Ai-je besoin de DotMD Reviewer pour commenter ?
Oui. Les commentaires et les relectures font partie de DotMD Reviewer, $39.99 une fois. La lecture est gratuite.