zeeple zeeple - 2 months ago 12
Markdown Question

Comments in TFS Markdown Widgets

How does one comment out a line inside a TFS Markdown Widget? When I say "comment out" what I am referring to is making a line of text not visible to the view when it is saved. In other words, a line of text that is only viewable to me (as the editor) when I open the widget for editing.

<!--- This does not work -->
[comment]: # This does not work
[comment]: <> This does not work
// This does not work
/* This does not work */


Update: These DO work:

[comment]: # (This does work)
[//]: # (This does work)


The key, and I did not realize this, is that the comment itself has to be inside parens. And what I have further discovered is that only the open parens is required!

Answer

Update:

Both [comment]: # and [comment]: <> should be work. It's regardless of the content in []. So, there is no difference between [comment] or [\\], even[123].

However, suggest you use # instead of <>, also add an empty line before the comment.

The most platform-independent syntax is

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

More detail info you can refer the answer from Nick Volynkin Comments in Markdown.


Moreover, here's some basic Markdown syntax guidance. For more, see Daring Fireball. enter image description here enter image description here enter image description here

Here is Markdown guidance in VSTS and TFS.

Comments