2011-01-24 11 views

Odpowiedz

0

Sprawdź: http://docutils.sourceforge.net/docs/user/rst/quickref.html#comments

Każdy tekst, który zaczyna się od wyraźnego początku znaczników ale nie wykorzystuje składnię któregokolwiek z powyższych konstruktów jest komentarz.

+6

Ta odpowiedź byłaby lepsza z przykładem. – bariumbitmap

+16

** To jest okropna odpowiedź. ** Warunkowość komentarzy reStructuredText nadmiernie komplikuje sprawy. Zrozumiałe "RTFM", po którym następuje jednoliniowy cytat _nie_ jest wystarczające. To, co jest i nie jest prawidłowym komentarzem leksykalnym, zależy od treści tego komentarza i od składni użytej do określenia tego komentarza. Jest nietrywialny, nieoczywisty i tragicznie kruchy. –

44

From the reference:

arbitralny wcięte tekst może śledzić wyraźny początek znaczników i będzie przetwarzane jako element komentarza.

.. This is a comment 
.. 
    _so: is this! 
.. 
    [and] this! 
.. 
    this:: too! 
.. 
    |even| this:: ! 
+5

Jako dodatek do tej pomocnej odpowiedzi, pierwsza forma (tj. '" .. To jest komentarz "') powinna _never_ być używana w praktyce. Zasadniczo uważany za szkodliwy. Czemu? Ponieważ warunkowość. Każdy komentarz zdefiniowany w ten sposób, którego pierwszy wiersz odpowiada składni jakiegokolwiek istniejącego jawnego konstruktu znaczników (np. Cytat, dyrektywa, przypis, podstawienie) zostanie cicho zinterpretowany jako konstrukcja, a nie jako komentarz - ** który jest okropny. ** Aby temu zapobiec, bezwarunkowo prefiks _all_ komentarze za pomocą pojedynczej linii '" .. "" jak w pozostałej części powyższych przykładów. –

+0

Biorąc pod uwagę to, co powiedział Cecil Curry, byłoby miło, gdyby @jball zrewidował swój przykład, pokazując najpierw idealną formę, więc nie muszę czytać całego drobnego druku, aby w moim reST zamienić śmierdzący komentarz. Ponadto zakładam, że mogę umieścić to, co chcę, w komentarzu, więc wszystkie dodatkowe symbole w innych przykładach służą jedynie komplikowaniu prostej, w przeciwnym razie odpowiedzi ... chyba że są one istotne. Czy oni są? – JFlo

Powiązane problemy