dotnet / dotnet/docfx

Code snippet notation proposal for CSHTML files

Open
#3,013 1 comment 0 reactions 0 assignees View on GitHub
dotnet
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**DocFX Version Used**:
2.37.0.0

Per [this doc](http://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#tag-name-representation-in-code-snippet-source-file), the following syntax is used to denote a snippet in a *.cshtml file:

> Start with: ``
> End with: ``

This syntax is less than desirable in *.cshtml files, as it results in an HTML comment in the DOM. The following syntax is preferred, since it doesn't render in the DOM:

Start with: `@* *@`
End with: `@* *@`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.