Комментарии в уценке

Question

Каков синтаксис для хранения комментария в файле уценки, например, комментарий CVS $ Id $ в верхней части файла?Я ничего не нашел в проекте по уценке .

Answer 1

<!--- ... --> 

Не работает в Pandoc Markdown (Pandoc 1.12.2.1). Комментарии все еще появились в html. Следующее сработало:

Blank line
[^Comment]:  Text that will not appear in html source
Blank line

Затем используйте расширение + сноска. По сути, это сноска, на которую никогда не ссылаются.

Answer 2

kramdown - движок уценки на основе Ruby, который используется по умолчанию для Jekyll и, следовательно, GitHub Pages - имеет встроенную поддержку комментариев благодаря синтаксису расширения :

{::comment}
This text is completely ignored by kramdown - a comment in the text.
{:/comment}

Do you see {::comment}this text{:/comment}?
{::comment}some other comment{:/}

Это имеет то преимущество, что позволяет добавлять комментарии в строке, но недостатком является невозможность переноса на другие механизмы Markdown.

Answer 3

Для pandoc хорошим способом блокировки комментариев является использование метаблока yaml, , как предложено автором pandoc . Я заметил, что это дает более правильную подсветку синтаксиса комментариев по сравнению со многими другими предлагаемыми решениями, по крайней мере, в моей среде (vim, vim-pandoc и vim-pandoc-syntax).

Я использую комментарии блока yaml в сочетании с html-встроенными комментариями, поскольку html-комментарии не могут быть вложенными . К сожалению, нет способа комментировать блок внутри метаблока yaml , поэтому каждая строка должна быть прокомментирована индивидуально. К счастью, в мягком абзаце должна быть только одна строка.

В моем ~/.vimrc я настроил собственные ярлыки для комментариев блока:

nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down>
nmap <Leader>v {jddx}kdd

Я использую , как мой <Leader> ключ, поэтому ,b и ,v комментируют и раскомментируют абзац соответственно. Если мне нужно прокомментировать несколько абзацев, я сопоставляю j,b с макросом (обычно Q) и запускаю <number-of-paragraphs><name-of-macro> (например, (3Q). То же самое работает для раскомментирования.

Answer 4

Можно попробовать

[](
Your comments go here however you cannot leave
// a blank line so fill blank lines with
//
Something
)

Answer 5

Вы можете сделать это (блок YAML):

~~~
# This is a
# multiline
# comment
...

Я пробовал только с выводом латекса, пожалуйста, подтвердите для других.

Answer 6

Github README.md ИЛИ Stackoverflow отвечает

Для ответов Github README или Stackoverflow я использую # для встроенного комментария.

Пример:

# clone the remote repository to your local machine

npm clone https://github.com/chebaby/echebaby.git

# change directory

cd echebaby

# install dependencies

yarn install