마크 다운의 코멘트

마크 다운 파일에 주석을 저장하는 구문은 무엇입니까 (예 : 파일 상단의 CVS $ Id $ 주석)? 마크 다운 프로젝트 에서 아무것도 찾지 못했습니다 .

이전에 제안 된 모든 솔루션 (특정 구현이 필요한 솔루션 제외)은 주석이 표시되지 않더라도 출력 HTML에 주석이 포함된다고 생각합니다.

자신에게만 맞는 주석을 원할 경우 (변환 된 문서를 읽는 사람이 "소스보기"로도 볼 수 없어야 함) 링크 레이블 (참조 스타일 링크와 함께 사용)을 사용할 수 있습니다. 핵심 마크 다운 사양에서 사용 가능 :

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)

이식성을 최대화하려면이 유형의 주석 전후에 빈 줄을 삽입해야합니다. 정의가 일반 텍스트에 대해 브러시 될 때 일부 마크 다운 구문 분석기가 올바르게 작동하지 않기 때문입니다. Babelmark에 대한 가장 최근의 연구에 따르면 전후의 빈 줄이 모두 중요합니다. 빈 줄이없는 경우 일부 파서는 주석을 출력하고, 빈 줄이없는 경우 일부 파서는 다음 줄을 제외합니다.

일반적으로이 접근법은 핵심 사양의 일부이므로 대부분의 Markdown 파서에서 작동합니다. (여러 링크가 정의되거나 링크가 정의되었지만 사용되지 않은 경우의 동작이 엄격하게 지정되지 않은 경우에도)

나는 표준 HTML 태그를 사용한다.

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

트리플 대시에 유의하십시오. 장점은 TeX 또는 HTML 출력을 생성 할 때 pandoc 과 함께 작동한다는 것 입니다. 자세한 내용은 pandoc-discuss 그룹 에서 확인할 수 있습니다 .

이 작은 연구는 Magnus의 답변을 입증하고 개선 합니다.

가장 플랫폼 독립적 인 구문은

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

두 가지 조건이 모두 중요합니다.

1. 사용 #(하지 <>)
2. 주석 앞에 빈 줄이 있습니다. 주석 다음의 빈 줄은 결과에 영향을 미치지 않습니다.

엄격한 마크 다운 사양 CommonMark 는이 구문에서 의도 한 대로만 작동합니다 ( <>빈 줄은 사용 하지 않음 ).

이를 증명하기 위해 John MacFarlane이 작성한 Babelmark2를 사용합니다. 이 도구는 28 Markdown 구현에서 특정 소스 코드의 렌더링을 확인합니다.

( +— 테스트를 통과했지만, -통과하지 못했습니다 ?— 렌더링 된 HTML에 표시되지 않은 일부 쓰레기가 남습니다.)

• <>13+, 15-를 사용하여 빈 줄이 없음
• 주석 앞에 빈 줄,<> 20+, 8-
• <>20+, 8-를 사용하여 주석 주위에 빈 줄
• #13+ 1을 사용하여 빈 줄이 없습니까? 14-
• #23+ 1을 사용하여 주석 앞에 빈 줄 ? 4-
• 23 +# 1을 사용하여 주석 주위에 빈 줄이 있습니까? 4-
• 하이픈이 3 개인 HTML 주석 1+ 2? 25- chl의 답변 (이것은 다른 구문입니다)

이것은 위의 진술을 증명합니다.

이러한 구현은 7 가지 테스트 모두에 실패합니다. 렌더링시 제외 된 의견을 사용할 수 없습니다.

• cebe / markdown 1.1.0
• cebe / markdown MarkdownExtra 1.1.0
• cebe / markdown GFM 1.1.0
• s9e \ TextFormatter (패트 다운 / PHP)

Jekyll 또는 octopress를 사용하는 경우 다음도 작동합니다.

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

Liquid 태그 {% comment %}는 먼저 구문 분석되어 MarkDown 프로세서가 도달하기 전에 제거됩니다. 방문자는 브라우저에서 소스를 보려고 할 때 볼 수 없습니다.

대안은 양식화 된 HTML 태그 내에 주석을 넣는 것입니다. 이렇게하면 필요에 따라 가시성을 전환 할 수 있습니다. 예를 들어 CSS 스타일 시트에서 주석 클래스를 정의하십시오.

.comment { display: none; }

그런 다음 향상된 MARKDOWN

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

브라우저에 다음과 같이 나타납니다

We do support comments

이것은 GitHub에서 작동합니다.

[](Comment text goes here)

결과 HTML은 다음과 같습니다.

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

기본적으로 빈 링크입니다. 분명히 렌더링 된 텍스트의 소스에서 읽을 수는 있지만 어쨌든 GitHub에서 읽을 수 있습니다.

Vim Instant-Markdown 사용자는 다음을 사용해야합니다.

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

또한 많은 수의 마크 다운 도구가 지원하는 Critic Markup을 참조하십시오.

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.

주석이 아닌 비 에코 R 블록에 주석을 넣는 것은 어떻습니까? 즉,

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

나를 위해 잘 작동하는 것 같습니다.

공개 : 나는 플러그인을 썼다.

질문에 특정 마크 다운 구현을 지정하지 않기 때문에 위에서 언급 한 것과 동일한 판 독 주석 스타일을 구현하는 python-markdown 의 Comments Plugin에 대해 언급하고 싶습니다 .

<!--- ... --> 

Pandoc Markdown (Pandoc 1.12.2.1)에서는 작동하지 않습니다. 주석은 여전히 ​​html로 나타납니다. 다음은 효과가있었습니다.

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

그런 다음 + 각주 확장명을 사용하십시오. 본질적으로 결코 참조되지 않는 각주입니다.

다음은 매우 잘 작동합니다

<empty line>
[whatever comment text]::

방법을 활용하는 것이 기준 링크를 통해 만들 신택스
로 작성된 링크 기준 보낸 [1]: http://example.org렌더링되지 않을 것, 마찬가지로 모든 다음의 표현이 아니라되지

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

pandoc의 경우, 주석을 차단하는 좋은 방법 은 pandoc author가 제안한대로 yaml 메타 블록을 사용하는 것입니다 . 나는이 내 환경 적어도 다른 제안 된 솔루션의 많은에 비해 코멘트 더 적절한 구문 강조를주는 것으로 나타났습니다 ( vim, vim-pandoc, 및 vim-pandoc-syntax).

html-comments를 중첩 할 수 없으므로 yaml 블록 주석을 html-inline comment와 함께 사용합니다 . 불행히도, yaml metablock 내에는 블록 주석 처리 방법이 없으므로 모든 행은 개별적으로 주석 처리해야합니다. 다행히도, 줄 바꿈 된 단락에는 한 줄만 있어야합니다.

내에서는 ~/.vimrc블록 주석에 대한 사용자 정의 바로 가기를 설정했습니다.

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

내가 사용하는 ,내 것처럼 <Leader>그렇게, - 키 ,b와 ,v주석 및 주석 단락, 각각. 여러 단락에 주석을 달아야 할 j,b경우 매크로 (일반적으로 Q)에 매핑 하고 실행 <number-of-paragraphs><name-of-macro>(예 : ( 3Q))합니다.

kramdown 지킬에 대한 기본 따라서 GitHub의 페이지로가는 링크가 -THE 루비 기반 인하 엔진 을 내장하고 그것의 확장 구문을 통해 주석 지원 :

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

이는 인라인 주석을 허용하지만 다른 Markdown 엔진으로 이식 할 수 없다는 단점이 있습니다.

당신은 시도 할 수 있습니다

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

이를 수행 할 수 있습니다 (YAML 블록).

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

라텍스 출력으로 만 시도했지만 다른 사람을 확인하십시오.