CSHTML/Razor 视图的文档

Jam*_*aug 5 c# documentation asp.net-mvc razor

我正在努力记录我们的显示和编辑器模板(作为扩展,记录我们所有的 CSHTML 将是有益的)。话虽如此,我从未见过任何记录 CSHTML Razor 视图的方法。

例如,我有这个 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>
Run Code Online (Sandbox Code Playgroud)

我知道这不是 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>
Run Code Online (Sandbox Code Playgroud)

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

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

Max*_*Max 1

我也研究过这个,但我找不到任何记录 a 的方法View,现在我刚刚在 中记录了视图Controller

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

您可以使用 SandCastle(我更喜欢这个)或 GhostDoc 等生成文档。


当然你View也可以在你的解释中写下正常的评论。

@* This is a comment *@
Run Code Online (Sandbox Code Playgroud)