Commentaire de marque
Markdown est indépendant de la plate-forme et peut être transporté dans pratiquement n'importe quelle application. En conséquence, il a acquis une utilisation approfondie dans le développement Web telles que les blogs, les documents, les cahiers, les e-mails, et etc.
Comment fonctionne Markdown?
Comme mentionné, Markdown est une langue de balisage. Par conséquent, vous travaillez dans un fichier se terminant par .MD ou .Extension de marque. Ce fichier contient des éléments de formatage tels que des titres, des blocs de code, des indentations, des alignements, et etc.
Le document Markdown est traité par une application connue sous le nom de processeur de Markdown ou d'analyseur. L'analyseur prend ensuite le texte formaté et produit le document HTML. Vous pouvez ensuite afficher le document HTML dans un navigateur ou toute application qui le prend en charge.
L'image ci-dessous illustre comment ce processus fonctionne.
(Cette image est un guide de démarque.)
Vous pouvez en savoir plus sur le fonctionnement de Markdown dans la ressource ci-dessous:
https: // www.MarkdownGuide.org /
Qu'est-ce qu'un commentaire Markdown?
Un commentaire Markdown fait référence à un texte ajouté à un fichier Markdown mais ignoré par l'application Renderer. Ainsi, un commentaire Markdown ne s'affiche pas dans la sortie générée.
Les commentaires sont utiles lorsque vous devez inclure du texte caché dans votre document qui n'est visible que l'auteur du document mais non exposé sur le document résultant.
Comment insérer des commentaires de Markdown
Malheureusement, Markdown ne fournit pas de support natif pour les commentaires. Cependant, vous pouvez utiliser des solutions importées pour ajouter des commentaires à votre document Markdown.
Méthode 1
La première syntaxe pour ajouter un commentaire dans Markdown consiste à placer votre texte de commentaire à l'intérieur d'une paire de crochets, suivi d'un côlon, d'un espace et d'un signe de livre.
La syntaxe est comme indiqué:
[comment_text]: #
Le texte à l'intérieur des crochets est traité comme un commentaire et ignoré par le rendu de Markdown.
Un exemple est comme indiqué:
## Illustration de commentaire de markdown
C'est un paragraphe
[Ceci est un commentaire]: #
Le commentaire ci-dessus n'est pas visible.
Dans l'exemple ci-dessus, nous avons une syntaxe de marque simple avec un titre, un paragraphe, un commentaire et un autre paragraphe.
Méthode 2
La syntaxe ci-dessous peut également insérer des commentaires dans un document Markdown.
[//]: # (le texte du commentaire va ici)
Ceci est considéré comme le format le plus compatible pour la plate-forme pour ajouter des commentaires.
Une autre variation de cette syntaxe est:
[//]: # "Le texte de commentaire va ici"
Méthode 3
Dans certains moteurs Markdown, vous pouvez ignorer les deux barres obliques et utiliser la syntaxe ci-dessous:
[]: # (texte de commentaire)
ou
[]: # "texte de commentaire"
ou
[]: # «Texte de commentaires»
Méthode 4
Vous pouvez également inclure des commentaires HTML dans Markdown, comme illustré dans la syntaxe ci-dessous:
Les applications de Markdown populaires prennent en charge la méthode ci-dessus.
Méthode 5
GitHub vous permet également d'utiliser la syntaxe ci-dessous pour indiquer les commentaires:
:: commentaire
commentaire du texte
:/commentaire
Bien que la syntaxe ci-dessus soit qu'il n'est pas conventionnellement adopté et utilisé.
Fermeture
Dans ce tutoriel, vous avez découvert cinq méthodes efficaces pour ajouter des commentaires à votre commentaire Markdown.