为什么 Visual Studio 代码格式不适用于 Razor 标记？

Question

或者，我应该问一下，VS 代码格式何时可以正常用于 Razor 标记？格式适用于大多数结构，但它似乎阻塞了“if”块。下面的代码是由 VS 格式化的。修复这种情况很容易，再加一个缩进，但我很好地接受了日常使用的格式，并且喜欢经常在我的大部分代码中使用它，所以如果可能的话，我宁愿避免手动格式化。现在我只是将其保留为 VS 格式化它。

@{ 
    if (User.Identity.IsAuthenticated)
    {
    <text>Hello </text>
    @Html.Display("@ViewBag.UserName") <text> - </text>
    @Html.ActionLink("Sign Out", "LogOff", "Account", null, new { style = "font-weight: bold;" })
    }
 }

我认为这对于可读性很重要，例如在上面， if 块的主体是缩进的，除了看起来更好。

Answer 1

它并非在所有情况下都能正常工作，因为这是一个难以解决的问题。本质上，您有 3 个不同的编辑器（HTML、C# 和 Razor）都在同一个文本缓冲区上进行交互。在某些情况下（例如这种情况），交互存在错误。但我们正在努力改进 Razor 下一版本的编辑器。

Answer 2

确保将编辑器设置为使用空格字符而不是制表符。使用选项卡时，编辑器似乎完全失去了理智。这是一种耻辱，因为所有这些空格字符最终都会出现在实际的 HTML 输出中，从而大大增加了数据传输的大小。 我所做的是在我键入时手动补充自动格式。不理想，但希望微软能在下一个服务包中解决这个问题。

Answer 3

我找到了一个“解决方案”，可以让您继续使用制表符缩进并具有正确的格式。它更像是一种模式。关键是使用剃刀代码块而不是内联代码。

因此，例如，替换以下内容：

<div>
    <div>
        @if (true)
        {
            <b>Hi</b>
        }
    </div>
</div>

与：

<div>
    <div>
        @{
            if (true)
            {
                <b>Hi</b>
            }
        }
    </div>
</div>

后者会正确格式化，但前者不会。

请记住，格式并不完美，但比以前更好。

Answer 4

这里更好的选择（而不是使用空格作为制表符）是将 HTML 和 C#/VB 的块缩进更改为“块”而不是“智能”。这不是一个完整的解决方案，但与使用空格相比，IMO 的痛苦要小得多！

Answer 5

我建议您通过注释您粘贴的代码段来防止触发自动格式化。这样就不会在粘贴时损坏。

Answer 6

我知道这并不是您真正想要的答案，但我使用 WriteLiteral 来解决我的格式问题。

比如我写的时候：

<div>
    @foreach (var item in Model) {    
        if (condition) {
            @:</div><div>
        }
        <a href="@item.Url">@item.Label</a>
    }
</div>

Visual Studio 尝试将其更改为：

<div>
    @foreach (var item in Model) {    
        if (condition) {
            @:
        </div><div>
        }
        <a href="@item.Url">@item.Label</a>
    }
</div>

这会导致页面抛出错误。

如果您使用 WriteLiteral，您可以欺骗格式化程序忽略该行，但它并不漂亮：

<div>
    @foreach (var item in Model) {    
        if (condition) {
            WriteLiteral("</div><div>");
        }
        <a href="@item.Url">@item.Label</a>
    }
</div>

Answer 7

现在我在 VS2013 ASP.NET MVC 5 上，我仍然有这个问题。我发现很有帮助的是将第一个表达式放在开始块符号所在的同一行（@{）。这样，剃须刀代码格式会产生更好的结果。以下是之前和之后的案例：

之前

之后

Answer 8

在我的例子中，它是 reshaper 覆盖格式选项。

如果您使用 reshaper 并遇到此问题，请尝试以下操作...

Resharper >> 选项 >> Razor >> 编辑器和格式 >> 取消勾选“输入时自动格式化”

Answer 9

我为此找到了另一种解决方案。只需选择文件中的所有代码，单击 Shift + tab 删除代码之前的所有选项卡，复制并粘贴它。 Visual Studio 自动格式化代码。处理 VS 2013 .cshtml 文件

Answer 10

我使用 VS2017 15.9.2 仍然存在问题。
将编辑器设置更改为使用空格而不是制表符后，编辑行为（例如复制 - 粘贴代码行）要好得多，但“格式化文档”仍然会在每次调用时添加错误的缩进。

没有解决方案，但有一个简短的更新：

该问题似乎在 Visual Studio 2019 版本 16.0 Preview 2.1 中部分解决
Link to MS for the issue

进一步的简短更新：
我找到了一种（糟糕且丑陋的）解决方法（将整个代码写入 ONE 行中的剃须刀控件。 你可以在这里找到详细信息Workaround to wrong indentation Razor Controls

Answer 11

您可能想尝试Improvements to the new Razor editor in Visual Studio - 它极大地提高了格式化质量（尽管仍然不完美）。