Pertanyaan Komentar dalam Markdown


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


956
2018-01-28 00:18


asal


Jawaban:


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

Jika Anda ingin komentar yang benar-benar untuk diri sendiri (pembaca dokumen yang dikonversi seharusnya tidak dapat melihatnya, bahkan dengan "view source") Anda bisa (ab) menggunakan label tautan (untuk digunakan dengan tautan gaya referensi) yang tersedia dalam spesifikasi Markdown 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 keystroke) juga dapat digunakan # (yang merupakan target hyperlink yang sah), bukan <>:

[//]: # (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 Markdown tidak menghubungkan definisi menyikat 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 ini adalah bagian dari spesifikasi inti. (bahkan jika perilaku ketika beberapa tautan didefinisikan, atau ketika tautan didefinisikan tetapi tidak pernah digunakan, tidak ditentukan secara ketat).


990
2018-01-02 15:18



Saya menggunakan tag HTML standar, seperti

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

Perhatikan triple dash. Keuntungannya adalah ia bekerja dengan pandoc saat menghasilkan keluaran TeX atau HTML. Informasi lebih lanjut tersedia di pandoc-diskusikan kelompok.


779
2018-01-28 15:36



Penelitian kecil ini membuktikan dan memurnikan jawabannya oleh Magnus

Sintaks yang paling platform-independen adalah

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

Kedua kondisi itu penting:

  1. Menggunakan # (dan tidak <>)
  2. Dengan garis 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 garis kosong)

Untuk membuktikan ini kita akan menggunakan Babelmark2, yang ditulis oleh John MacFarlane. Alat ini memeriksa perenderan kode sumber tertentu dalam 28 implementasi Penetapan Mundur.

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

Ini membuktikan pernyataan di atas.

Implementasi ini gagal semua 7 tes. Tidak ada kesempatan untuk menggunakan komentar yang dikecualikan di-render dengan mereka.

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

116
2017-08-24 19:17



Jika Anda menggunakan Jekyll atau octopress berikut ini juga akan berfungsi.

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

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


42
2018-04-05 02:57



Alternatifnya adalah menempatkan komentar 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


33
2018-02-22 18:11



Ini berfungsi di GitHub:

[](Comment text goes here)

HTML yang dihasilkan tampak seperti:

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

Yang pada dasarnya adalah tautan kosong. Tentunya Anda dapat membaca itu di sumber teks yang diberikan, tetapi Anda dapat melakukannya di GitHub pula.


25
2018-04-19 00:19



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.

15
2018-03-31 11:17



Bagaimana tentang menempatkan komentar di blok R non-gema, non-gema? yaitu.,

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

Sepertinya bekerja dengan baik untukku.


11
2017-11-23 03:19



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.


10
2017-08-22 10:00



<!--- ... --> 

Tidak berfungsi di Pandoc Markdown (Pandoc 1.12.2.1). Komentar masih muncul di html. Yang berikut 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.


9
2018-02-23 16:13



Vim Penetasan-Instan pengguna harus digunakan

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

8
2017-11-01 18:47