Komentar dalam penurunan harga

Apa sintaksis untuk menyimpan komentar dalam file penurunan harga, misalnya komentar $ Id $ CVS di bagian atas file? Saya tidak menemukan apa pun di proyek penurunan harga .

Saya percaya bahwa semua solusi yang diusulkan sebelumnya (selain dari yang membutuhkan implementasi spesifik) menghasilkan komentar yang dimasukkan dalam output HTML, bahkan jika mereka tidak ditampilkan.

Jika Anda menginginkan komentar yang hanya untuk Anda sendiri (pembaca dokumen yang dikonversi tidak dapat melihatnya, bahkan dengan "sumber tampilan") Anda dapat (ab) menggunakan label tautan (untuk digunakan dengan tautan gaya referensi) yang tersedia dalam spesifikasi Penurunan harga inti:

http://daringfireball.net/projects/markdown/syntax#link

Itu adalah:

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

Atau Anda bisa melangkah lebih jauh:

[//]: <> (This is also a comment.)

Untuk meningkatkan kompatibilitas platform (dan untuk menyimpan satu penekanan tombol) juga dimungkinkan untuk menggunakan #(yang merupakan target hyperlink yang sah) alih-alih <>:

[//]: # (This may be the most platform independent comment)

Untuk portabilitas maksimum, penting untuk menyisipkan baris kosong sebelum dan sesudah jenis komentar ini, karena beberapa parser penurunan harga tidak berfungsi dengan benar ketika definisi menyapu terhadap teks biasa. Penelitian terbaru dengan Babelmark menunjukkan bahwa garis kosong sebelum dan sesudah keduanya penting. Beberapa parser akan menampilkan komentar jika tidak ada baris kosong sebelumnya, dan beberapa parser akan mengecualikan baris berikut jika tidak ada baris kosong setelahnya.

Secara umum, pendekatan ini harus bekerja dengan sebagian besar parser Markdown, karena itu adalah bagian dari spesifikasi inti. (bahkan jika perilaku ketika banyak tautan didefinisikan, atau ketika tautan didefinisikan tetapi tidak pernah digunakan, tidak ditentukan secara ketat).

Saya menggunakan tag HTML standar, seperti

<!---
your comment goes here
and here
-->

Perhatikan dasbor tiga. Keuntungannya adalah ia bekerja dengan pandoc saat menghasilkan keluaran TeX atau HTML. Informasi lebih lanjut tersedia di grup pandoc-mendiskusikan .

Penelitian kecil ini membuktikan dan memperbaiki jawaban oleh Magnus

Sintaksis platform paling independen adalah

(empty line)
[comment]: # (This actually is the most platform independent comment)

Kedua kondisi itu penting:

1. Menggunakan #(dan tidak <>)
2. Dengan baris kosong sebelum komentar . Baris kosong setelah komentar tidak berdampak pada hasil.

Spesifikasi Markdown yang ketat CommonMark hanya berfungsi sebagaimana dimaksud dengan sintaks ini (dan tidak dengan <>dan / atau baris kosong)

Untuk membuktikan ini, kita akan menggunakan Babelmark2, yang ditulis oleh John MacFarlane. Alat ini memeriksa rendering kode sumber tertentu dalam 28 implementasi penurunan harga.

( +- lulus tes, -- tidak lulus, ?- meninggalkan beberapa sampah yang tidak ditampilkan dalam HTML yang diberikan).

• Tidak ada baris kosong, menggunakan<> 13+, 15-
• Baris kosong sebelum komentar, menggunakan<> 20+, 8-
• Baris kosong di sekitar komentar, menggunakan<> 20+, 8-
• Tidak ada baris kosong, menggunakan# 13+ 1? 14-
• Baris kosong sebelum komentar, menggunakan # 23+ 1? 4-
• Baris kosong di sekitar komentar, menggunakan# 23+ 1? 4-
• Komentar HTML dengan 3 tanda hubung 1+ 2? 25- dari jawaban chl (perhatikan bahwa ini adalah sintaks yang berbeda)

Ini membuktikan pernyataan di atas.

Implementasi ini gagal semua 7 tes. Tidak ada kesempatan untuk menggunakan komentar yang dikecualikan saat memberikannya.

• cebe / penurunan harga 1.1.0
• cebe / penurunan harga MarkdownExtra 1.1.0
• cebe / penurunan harga GFM 1.1.0
• s9e \ TextFormatter (Fatdown / PHP)

Jika Anda menggunakan Jekyll atau octopress berikut juga akan berfungsi.

{% comment %} 
    These commments will not include inside the source.
{% endcomment %}

Tag Liquid {% comment %}diuraikan terlebih dahulu dan dihapus sebelum prosesor MarkDown bahkan sampai ke sana. Pengunjung tidak akan melihat ketika mereka mencoba untuk melihat sumber dari browser mereka.

Alternatifnya adalah dengan memberikan komentar di dalam tag HTML bergaya. Dengan cara ini, Anda dapat mengubah visibilitas mereka sesuai kebutuhan. Misalnya, tentukan kelas komentar di stylesheet CSS Anda.

.comment { display: none; }

Kemudian, MARKDOWN yang disempurnakan berikut

We do <span class="comment">NOT</span> support comments

muncul sebagai berikut dalam BROWSER

We do support comments

Ini bekerja pada GitHub:

[](Comment text goes here)

HTML yang dihasilkan terlihat seperti:

<a href="Comment%20text%20goes%20here"></a>

Yang pada dasarnya adalah tautan kosong. Jelas Anda dapat membacanya di sumber teks yang diberikan, tetapi Anda tetap dapat melakukannya di GitHub.

Pengguna Vim Instant-Markdown perlu digunakan

<!---
First comment line...
//
_NO_BLANK_LINES_ARE_ALLOWED_
//
_and_try_to_avoid_double_minuses_like_this_: --
//
last comment line.
-->

Juga lihat Critic Markup, didukung oleh semakin banyak alat Markdown.

http://criticmarkup.com/

Comment {>> <<}

Lorem ipsum dolor sit amet.{>>This is a comment<<}

Highlight+Comment {== ==}{>> <<}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus.

Bagaimana dengan menempatkan komentar di blok R non-eval, non-echo? yaitu,

```{r echo=FALSE, eval=FALSE}
All the comments!
```

Tampaknya bekerja dengan baik untuk saya.

Pengungkapan: Saya menulis plugin.

Karena pertanyaan tidak menentukan implementasi penurunan harga tertentu, saya ingin menyebutkan Plugin Komentar untuk python-markdown , yang mengimplementasikan gaya komentar pandoc yang sama yang disebutkan di atas.

<!--- ... --> 

Tidak berfungsi di Pandoc Markdown (Pandoc 1.12.2.1). Komentar masih muncul di html. Berikut ini berhasil:

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

Kemudian gunakan ekstensi + catatan kaki. Ini pada dasarnya adalah catatan kaki yang tidak pernah direferensikan.

Berikut ini bekerja dengan sangat baik

<empty line>
[whatever comment text]::

metode yang memanfaatkan sintaks untuk membuat tautan melalui referensi
karena referensi tautan yang dibuat dengan [1]: http://example.orgtidak akan di-render, demikian juga salah satu dari berikut ini tidak akan dirender juga

<empty line>
[whatever]::
[whatever]:whatever
[whatever]: :
[whatever]: whatever

Untuk pandoc, cara yang baik untuk memblokir komentar adalah dengan menggunakan metablock yaml, seperti yang disarankan oleh penulis pandoc . Saya telah memperhatikan bahwa ini memberikan sintaks yang lebih tepat dari komentar dibandingkan dengan banyak solusi yang diusulkan lain, setidaknya di lingkungan saya ( vim, vim-pandoc, dan vim-pandoc-syntax).

Saya menggunakan komentar blok yaml dalam kombinasi dengan komentar html-inline komentar html tidak dapat disarangkan . Sayangnya, tidak ada cara untuk memblokir komentar di dalam metablock yaml , sehingga setiap baris harus dikomentari secara terpisah. Untungnya, seharusnya hanya ada satu baris dalam paragraf yang dibungkus dengan lembut.

Di saya ~/.vimrc , saya telah menyiapkan pintasan khusus untuk komentar blokir:

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

Saya menggunakan ,sebagai <Leader>-Kunci saya , jadi ,bdan ,vmengomentari dan menghapus komentar paragraf, masing-masing. Jika saya perlu mengomentari banyak paragraf, saya memetakan j,bke makro (biasanya Q) dan menjalankan <number-of-paragraphs><name-of-macro>(mis. ( 3Q). Hal yang sama berfungsi untuk tidak komentar.

kramdown — mesin penurunan harga berbasis Ruby yang merupakan default untuk Jekyll dan karenanya GitHub Pages — memiliki dukungan komentar bawaan melalui sintaksis ekstensi :

{::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{:/}

Ini memiliki manfaat memungkinkan komentar in-line, tetapi downside tidak portabel untuk mesin Markdown lainnya.

Anda dapat mencoba

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

Anda dapat melakukan ini (blok YAML):

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

Saya mencoba dengan keluaran lateks saja, mohon konfirmasi untuk orang lain.