假设我正在开发一个c#库,目标是两个不同的平台(比如,WinForms和Blazor)。
构建代码的一种方法是使用"core";一组作为partial
类的公共文件,这样我就可以在单独的文件中添加特定于平台的代码。所以内核可能有一个Point.cs
文件:
/// <summary>Class <c>Point</c> models a point in a two-dimensional
/// plane.</summary>
///
public partial class Point
{
/// <summary>method <c>draw</c> renders the point.</summary>
void draw() { ... }
}
我的问题:如果我想添加特定于平台的文档到Point.draw
怎么办?还是Point
课堂总结?
显然,对于部分类,我可以在PointBlazor.cs
和PointWinForms.cs
中添加新的平台特定方法,但我知道没有办法向现有方法或已在Point.cs
中定义的类本身添加文档,以便它们提到其他平台特定方法。这在c#中可能吗?
(例如,想象一下Point类的摘要可能只在Blazor中提到Point正在使用CSS坐标或类似的注释)
如果我想添加特定于平台的文档到…
xml文档中一个被忽略的标记是注释部分,它位于摘要部分之后,可用于处理一次性情景信息。
我建议你用这一节来指出基于技术的差异,像这样:
/// <summary>method <c>draw</c> renders the point.</summary>
/// <remarks>
/// If running in Blazor, only use on the client side. No issues on winforms.
/// </remarks>
/// <param name="claims"></param>