How to write a comment in a Razor view?

Question

How to write a comment in a MVC view, that won't be transmitted to the final HTML (i.e.,to browser, to response). One can make a comment with:

<!--<a href="/">My comment</a> -->

but, it is visible in the page source code in browser.

Is it possible to leave comments in '.cshtml' files only for internal use?

[C# Razor Syntax Quick Reference](http://haacked.com/archive/2011/01/06/razor-syntax-quick-reference.aspx) — KV Prajapati, Aug 29 '12 at 05:47
Found a duplicate of my question: http://stackoverflow.com/questions/3382903/razor-comment-syntax — horgh, Aug 29 '12 at 06:45
Another duplicate: http://stackoverflow.com/questions/4467496/how-do-you-declare-a-comment-using-the-razor-view-engine — Nathan Hartley, Dec 17 '15 at 19:17
Possible duplicate of [Razor comment syntax](http://stackoverflow.com/questions/3382903/razor-comment-syntax) — Jon Schneider, Jan 24 '17 at 14:47

score 342 · Accepted Answer · edited Aug 07 '19 at 10:53

342

Note that in general, IDE's like Visual Studio will markup a comment in the context of the current language, by selecting the text you wish to turn into a comment, and then using the Ctrl+K Ctrl+C shortcut, or if you are using Resharper / Intelli-J style shortcuts, then Ctrl+/.

Server side Comments:

Razor .cshtml

Like so:

@* Comment goes here *@

.aspx
For those looking for the older .aspx view (and Asp.Net WebForms) server side comment syntax:

<%-- Comment goes here --%>

Client Side Comments

HTML Comment

<!-- Comment goes here -->

Javascript Comment

// One line Comment goes Here
/* Multiline comment
   goes here */

As OP mentions, although not displayed on the browser, client side comments will still be generated for the page / script file on the server and downloaded by the page over HTTP, which unless removed (e.g. minification), will waste I/O, and, since the comment can be viewed by the user by viewing the page source or intercepting the traffic with the browser's Dev Tools or a tool like Fiddler or Wireshark, can also pose a security risk, hence the preference to use server side comments on server generated code (like MVC views or .aspx pages).

edited Aug 07 '19 at 10:53

mekb

554
8
22

answered Aug 29 '12 at 05:46

StuartLC

104,537
17
209
285

3

Forgot to try it))))) I usually use Ctrl+E,C and Ctrl+E,U. Thanks a lot – horgh Aug 29 '12 at 05:50
1

This response is incorrect. See the other response to this question. – Zackary Geers Apr 02 '18 at 17:48
2

@ZackaryGeers I'm not following - sobering's answer seems to have duplicated my original answer, and I've subsequently augmented to respond to the OP's concerns about keeping comments hidden for internal use. What is incorrect? – StuartLC May 24 '18 at 19:14
2

But I use the C# comment syntax (`//...`, `/*...*/`) in the Razor page. Shouldn't it actually be rendered as text? – mekb Aug 31 '19 at 12:55
3

It depends where you place the // comment. Razor can have C# sections (denoted by a starting @), Html and even JS sections Script sections. C# comments won't be echoed by the server. Comments in js and html will be sent to the browser.. // comments in Html will be regarded as text and will likely be visible to the end user. – StuartLC Sep 01 '19 at 06:12

score 30 · Answer 2 · answered Aug 29 '12 at 05:47

30

This comment syntax should work for you:

@* enter comments here *@

answered Aug 29 '12 at 05:47

sobering

544
4
10

How to write a comment in a Razor view?

2 Answers2

Linked