3.1. Razor комментарии

Razor - это как новый язык, а новые язык начинают со знакомства с комментариями. Как и в любом другом языке программирования комментарии не выполняются фреймворком, не влияют на результат и даже не отображаются на результирующей странице.

Комментарии в представлениях Razor пишутся между символами @* и *@ например:

@*
  Это многострочный комментарий 
  в Razor и .NET Core Web приложении
*@

Я противник комментариев и в моем коде очень редко можно увидеть их. Как советуют в книге Clean Code – код должен быть таким, чтобы его можно было читать без каких-либо дополнительных подсказок.

Очень часто программисты используют комментарии для того, чтобы временно отключить какой-то функционал. Я тоже так иногда поступаю, но только уж совсем для временного отключения. То же самое можно делать и в представлении. Причем комментарием становится совершенно все, включая HTML или код:

@*
<h1>@Model.LastName</h1>
*@

Здесь внутри комментария есть и HTML, и даже немного Razor кода. Ни то, ни другое на странице не отобразиться. Если HTML комментарии небезопасны, потому что их можно увидеть в исходнике страницы, то Razor комментарии безопасны, их в исходнике не будет видно.

Но даже не смотря на безопасность, использовать комментарии можно только для временного отключения и только в крайних случаях. Опять же, код должен быть и так понятным, а никаких отключений функционала хранить в странице нельзя, для этого есть git, поэтому просто удаляем функционал, а когда нужно его можно найти в истории и восстановить.