Как прокомментировать строку в реструктурированном тексте?

19

Комментарий HTML: <!-- .. --> , как я могу сделать этот блок комментариев с реструктурированным текстом? В порядке слов, как я могу прокомментировать некоторые строки в реструктурированном тексте?

    
задан prosseek 24.01.2011 в 16:36
источник

2 ответа

-1

Отметьте: Ссылка

  

Любой текст, начинающийся с явного запуска разметки, но не использующий синтаксис любой из вышеприведенных конструкций, является комментарием.

    
ответ дан yan 24.01.2011 в 16:41
  • Этот ответ был бы лучше с примером. –  Nathaniel M. Beaver 29.07.2016 в 20:29
  • Это ужасный ответ. Условность комментариев reStructuredText слишком усложняет ситуацию. Здесь не хватает ясного «RTFM», за которым следует однострочная цитата. То, что делает и не составляет допустимый комментарий, лексически зависит от содержимого этого комментария и синтаксиса, используемого для указания этого комментария. Это нетривиальный, неочевидный и трагически хрупкий. –  Cecil Curry 14.08.2016 в 03:09
46

Из справки :

  

Произвольный текст с отступом может следовать за   явный запуск разметки и будет   обрабатывается как элемент комментария.

.. This is a comment
..
   _so: is this!
..
   [and] this!
..
   this:: too!
..
   |even| this:: !
    
ответ дан jball 24.01.2011 в 16:41
  • Как дополнение к этому полезному ответу, первая форма (т. е. «.. это комментарий») никогда не должна использоваться на практике. В принципе, считается вредным. Зачем? Потому что обусловленность. Любой комментарий, определенный таким образом, чья первая строка соответствует синтаксису любой существующей конструкции явного разметки (например, цитата, директива, сноска, подстановка), будет молчаливо интерпретироваться как эта конструкция, а не как комментарий - что ужасно. Чтобы предотвратить это, безоговорочно префикс всех комментариев с помощью однострочного оператора «..», как в оставшейся части приведенных выше примеров. –  Cecil Curry 14.08.2016 в 03:18
  • Учитывая то, что сказал Сесил Карри, было бы очень приятно, если бы @jball пересмотрел бы его пример, чтобы сначала показать идеальную форму, поэтому мне не нужно читать весь мелкий шрифт, просто чтобы поместить комментарий stinkin в мой реестр. Кроме того, я уже предполагаю, что могу поместить все, что захочу, в комментарий, поэтому все дополнительные символы в других примерах только усложняют простой ответ ... если только это не относится к делу. Они? –  JFlo 28.02.2018 в 22:42