c# - CSHTML/Razor View 的文档

Question

我正致力于记录我们的显示和编辑器模板(并且作为扩展，记录我们所有的 CSHTML 将是有益的)。话虽如此，我从未见过任何记录 CSHTML Razor View 的方法。

例如，我有这个 CSHTML EditorTemplate:MoneyPicker.cshtml

@model Decimal?
@{
    Layout = null;
}
<div class="money-picker" data-money-picker>
    <div class="form-control-wrapper">
        @Html.TextBox(
            "",
            ViewData.TemplateInfo.FormattedModelValue,
            new
            {
                type = "number",
                @class = "form-control money-control",
                placeholder = ViewData.ModelMetadata.Watermark ?? ViewData.ModelMetadata.DisplayName
            } )
    </div>
</div>

我知道它不是 C#，但有什么方法可以添加 XML 文档(或等效文档):

    /// <summary>
    /// Displays a text box wrapped with the money-picker wrappers, allowing javascript to show money buttons to pick the value.
    /// </summary>
    /// <param name="Model">A currency value</param>
    /// <remarks>
    /// The input is a text box that has the type "number"
    /// </remarks>

或者，如果没有，是否有人找到了一些方法来记录编辑器/显示模板，这些模板可以由类似于 Asp.Net WebApi 的 api 帮助页面的某种系统获取？理想情况下，它会走得更远，从父类型开始，允许您深入了解该类型的每个属性编辑器等，但我只是想先从小处着手。

编辑:作为其中的一部分，我也很乐意生成模板的示例，而不必硬/手动编码所述示例，只是为了帮助阐明我的想法。

Answer 1

我也研究过这个，但我找不到任何方法来记录 View，现在我刚刚在 Controller 中记录了 View :

/// <summary>
/// This is an example of documentation for the View.
/// </summary>
/// <returns>This is what I am returning.</returns>
public ActionResult CreateNewUser()
{
    return View();
}

您可以为此生成文档，例如SandCaSTLe(我更喜欢这个)或 GhostDoc。

---

当然，您也可以在View 中编写普通注释以进行解释。

@* This is a comment *@