【问题标题】:Code documentation comments for ASP.NET razor pages?ASP.NET 剃须刀页面的代码文档注释?
【发布时间】:2020-09-27 12:37:42
【问题描述】:

是否可以将代码文档 cmets 添加到剃须刀页面(分别为:组件)?

我发现可以将标准文档 cmets 用于页面参数(在 @code 块中声明),但我仍在寻找一种为组件(类)本身添加 cmets 的方法。

对于参数,这是可行的:

@code
{
   /// <summary> The Id of the selected account. </summary>
   [Parameter]
   public int SelectedAccount { get; set; }
}

所以,对于一个类,它应该是这样的:

@***
    <summary> This component renders a table. </summary>
***@

@classcomment{
    <summary> This component renders a table. </summary>
}

有人知道方法吗?

【问题讨论】:

    标签: asp.net-core razor razor-pages


    【解决方案1】:

    我认为这不可能仅来自 .razor 文件。但是,您可以在可以放置文档的位置添加“代码隐藏”文件(当然,这并不理想,因为文档与 Razor 代码是分开的)。

    例如,让它成为你的Component.razor

    <p>Some component</p>
    
    @code
    {
       /// <summary> The Id of the selected account. </summary>
       [Parameter]
       public int SelectedAccount { get; set; }
    }
    

    您可以使用组件的文档注释创建Component.razor.cs(文件名并不重要,但遵循此方案是一个很好的约定):

    /// <summary> This component renders a table. </summary>
    partial class Component { }
    

    注意命名空间必须匹配(在这个例子中我没有使用任何命名空间,但是你可以通过.razor文件或文件夹结构中的@namespace指令和.cs中的namespace块指定命名空间像往常一样归档)。

    【讨论】:

    • 我也发现了这一点。显然这不是我想要的,但从技术上讲它回答了这个问题。可能仍然可以帮助其他人。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-11-28
    • 2022-11-28
    • 2013-02-22
    • 2020-02-02
    • 2014-03-09
    • 1970-01-01
    相关资源
    最近更新 更多