Commnets in Markdown

JSON API 스팩 문서를 다시 번역하면서 꽤나 긴 markdown 문서를 작성해야되는 경우가 발생했다. 그러다보니… 코멘트로 나눔이 필요한 경우가 발생!

구글에서 간단하게 검색하니 Comments in Markdown – Stackoverflow 라는 글이 하나 발견…

코멘트 남기는 방법은 다음처럼 구성하면 된다.

1
2

[comment]: # (This is a comment.)
[//]: # (This is a comment.)

개인적 취향은 두번째가 좋아보인다. 그리고 긴 코멘트가 필요하다면… HTML 코멘트 태그를 사용해도 좋을듯.

1
2
3

<!---
This is comment.
--->

오늘은 여기까지…