syntax - markdown شرح




تعليقات في تخفيض السعر (10)

أستخدم علامات HTML القياسية ، مثل

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

لاحظ اندفاعة ثلاثية. الميزة هي أنه يعمل مع pandoc عند توليد إخراج TeX أو HTML. مزيد من المعلومات متاحة على مجموعة pandoc-discuss .

ما هي صيغة تخزين تعليق في ملف تخفيض السعر ، على سبيل المثال تعليق CVS $ Id $ أعلى الملف؟ لم أجد شيئًا في مشروع تخفيض السعر .


أعتقد أن جميع الحلول المقترحة سابقاً (بخلاف تلك التي تتطلب تطبيقات محددة) تؤدي إلى تضمين التعليقات في HTML الناتج ، حتى إذا لم يتم عرضها.

إذا كنت تريد تعليقًا مخصصًا لك تمامًا (لا ينبغي أن يكون قارئي المستند المحوّل قادرين على رؤيته ، حتى مع "عرض المصدر") ، فيمكنك (ab) استخدام تسميات الروابط (للاستخدام مع وصلات الأنماط المرجعية) متاحة في مواصفات Markdown الأساسية:

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

هذا هو:

[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.)

أو يمكنك الذهاب أبعد من ذلك:

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

لتحسين توافق المنصة (ولحفظ ضغطة واحدة) ، من الممكن أيضًا استخدام # (وهو هدف ارتباط تشعبي شرعي) بدلاً من <> :

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

لأقصى قابلية النقل ، من المهم إدخال سطر فارغ قبل وبعد هذا النوع من التعليقات ، لأن بعض موزعي Markdown لا يقوموا بربط التعريفات بالفرشاة ضد النص العادي. أظهر أحدث الأبحاث التي أجريت مع Babelmark أن الخطوط الفارغة قبل وبعد كلتا المهمتين. سيقوم بعض موزعي الإخراج بإخراج التعليق إذا لم يكن هناك سطر فارغ قبل ، وسوف تستبعد بعض موزعي السطر التالي إذا لم يكن هناك سطر فارغ بعد.

بشكل عام ، يجب أن يعمل هذا الأسلوب مع معظم موزعي Markdown ، لأنه جزء من المواصفات الأساسية. (حتى إذا كان السلوك عندما يتم تحديد ارتباطات متعددة ، أو عندما يتم تعريف ارتباط ولكن لم يتم استخدامه مطلقًا ، لا يتم تحديده بدقة).


انظر أيضًا Mark Markup ، مدعومًا بعدد متزايد من أدوات 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.

بالنسبة لـ pandoc ، من الطرق الجيدة لمنع التعليق استخدام metablock yaml ، كما اقترح مؤلف pandoc . لقد لاحظت أن هذا يعطي إلقاء الضوء على التعليقات بشكل صحيح أكثر مقارنة مع العديد من الحلول المقترحة الأخرى ، على الأقل في البيئة الخاصة بي ( vim ، vim-pandoc ، و vim-pandoc-syntax ).

أستخدم تعليقات كتلة yaml مع التعليقات المضمنة بتنسيق html ، حيث لا يمكن تداخل تعليقات html . لسوء الحظ ، لا توجد طريقة لحظر التعليق داخل metablock yaml ، لذلك يجب التعليق على كل سطر على حدة. لحسن الحظ ، يجب أن يكون هناك سطر واحد فقط في فقرة softwrapped.

في ~/.vimrc ، أعددت اختصارات مخصصة لتعليق الحظر:

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

أستخدم , مثل <Leader> -key ، لذا ,b و ,v تعليق وعدم إلغاء فقرة ، على التوالي. إذا احتجت إلى التعليق على فقرات متعددة ، فإنني أقوم بتعيين j,b إلى ماكرو (عادة Q ) وتشغيل <number-of-paragraphs><name-of-macro> (على سبيل المثال ( 3Q ). يعمل نفس الشيء على uncommenting.


ماذا عن وضع التعليقات في كتلة غير صادقة وغير صدى؟ أي،

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

يبدو أنه ينفعني.


هذا البحث الصغير يثبت وينقح إجابة ماغنوس

بناء الجملة المستقل الأكثر المنصة هو

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

كلا الشرطين مهمان:

  1. باستخدام # (وليس <> )
  2. مع سطر فارغ قبل التعليق . لا يؤثر السطر الفارغ بعد التعليق على النتيجة.

مواصفات CommonMark الصارمة تعمل CommonMark فقط كما هو مقصود مع هذا النحو (وليس مع <> و / أو خط فارغ)

لإثبات ذلك ، سنستخدم Babelmark2 ، الذي كتبه John MacFarlane. تتحقق هذه الأداة من تقديم شفرة المصدر المعينة في عمليات 28 Markdown.

( + - اجتاز الاختبار ، - - لم تمر ، ? - يترك بعض القمامة التي لا تظهر في HTML المقدمة).

هذا يثبت البيانات أعلاه.

هذه التطبيقات تفشل جميع الاختبارات السبعة. ليس هناك فرصة لاستخدام تعليقات مستبعدة على العرض.

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

يحتاج مستخدمو Vim Instant-Markdown إلى الاستخدام

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

يمكنك المحاولة

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

الكشف: لقد كتبت البرنامج المساعد.

نظرًا لأن السؤال لا يحدد تطبيقًا محددًا للعلامات الهلالية ، فأنا أريد أن أذكر البرنامج الإضافي "تعليقات" لعنصر " python-markdown ، الذي يطبق نفس أسلوب التعليق على pandoc المذكور أعلاه.


<!--- ... --> 

لا يعمل في Pandoc Markdown (Pandoc 1.12.2.1). التعليقات لا تزال تظهر في أتش تي أم أل. ما يلي العمل:

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

ثم استخدم الامتداد + footnote. إنها في الأساس حاشية لا يتم الرجوع إليها.





markdown