2011-01-24 21 views

Trả lời

0

Kiểm tra: http://docutils.sourceforge.net/docs/user/rst/quickref.html#comments

Bất kỳ văn bản mà bắt đầu với một sự khởi đầu đánh dấu rõ ràng nhưng không sử dụng cú pháp của bất kỳ của các cấu trúc ở trên, là một nhận xét.

+6

Câu trả lời này sẽ tốt hơn với ví dụ. – bariumbitmap

+16

** Đây là một câu trả lời khủng khiếp. ** Điều kiện nhận xét của reStructuredText quá phức tạp. Một pithy "RTFM" theo sau là một câu lệnh đơn dòng _not_ đủ ở đây. Những gì và không cấu thành một nhận xét hợp lệ phụ thuộc vào nội dung của chú thích đó _and_ cú pháp được sử dụng để xác định chú thích đó. Nó không tầm thường, không rõ ràng và dễ vỡ. –

44

From the reference:

Arbitrary văn bản thụt vào có thể làm theo khi bắt đầu đánh dấu rõ ràng và sẽ được xử lý như một yếu tố nhận xét.

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

Là phụ lục cho câu trả lời hữu ích này, biểu mẫu đầu tiên (tức là, '" .. Đây là một chú thích "') nên _never_ được sử dụng trong thực tế. Về cơ bản, được coi là có hại. Tại sao? Bởi vì điều kiện. Bất kỳ chú thích nào được định nghĩa theo cách này có dòng đầu tiên khớp với cú pháp của bất kỳ cấu trúc đánh dấu rõ ràng hiện có nào (ví dụ trích dẫn, chỉ thị, chú thích, thay thế) sẽ được diễn giải lại âm thầm như cấu trúc đó chứ không phải là nhận xét - ** thật kinh khủng. ** Để ngăn chặn điều này, tiền tố vô điều kiện _all_ bình luận với một dòng lệnh '" .. "' như trong phần còn lại của các ví dụ trên. –

+0

Với những gì Cecil Curry đã nói, sẽ rất tuyệt nếu @jball sửa đổi ví dụ của mình để thể hiện một hình mẫu lý tưởng đầu tiên vì vậy tôi không cần đọc tất cả các bản in chỉ để đưa ra một bình luận đáng kinh ngạc trong reST của tôi. Ngoài ra, tôi đã giả sử tôi có thể đặt bất cứ điều gì tôi muốn vào một bình luận, vì vậy tất cả các biểu tượng thêm trong các ví dụ khác chỉ phục vụ để phức tạp một câu trả lời đơn giản khác ... trừ khi những người có liên quan. Có phải không? – JFlo

Các vấn đề liên quan