10得票4回答
如何在XML注释中放置代码示例?

我有一个像这样的XML注释。/// <summary> /// Lorem ipsum /// </summary> /// <param name="entity"></param> /// <returns></return...

9得票2回答
在Swagger中使用属性XML注释作为参数描述

我使用ASP.NET Core创建了一个Web API,并使用swagger创建文档。我在API端点上使用XML注释来提供文档中的附加信息。swagger配置如下: services.AddSwaggerGen(c => { c.SwaggerD...

19得票2回答
在C#中如何在XML文档注释之间跳转?

好的,这是一个愚蠢的问题,但在使用Visual Studio时,如果我正在用Visual Basic编写XML文档注释,我可以使用Tab键在字段之间切换(例如从概要到Param到Returns)。 但是,在C#中,按Tab键会插入制表符,因此我必须单击各个字段以导航到它们(或使用箭头键)。 这...

16得票2回答
如何使Visual Studio智能感知显示XML注释中的备注部分?

当编写代码时,我非常喜欢Visual Studio 2010(专业版)的Intellisense功能,特别是能够查看正在使用的类型的XML注释。 (请参阅Microsoft的文档)。到目前为止,这个功能还可以使用。 然而,XML代码注释的备注部分未显示。 我认为这是一个非常有用的功能,因为通...

22得票5回答
C#中的备注标签的目的是什么?

我知道remarks标签用于提供有关类的附加信息,但在悬停/调用该类时不会显示在智能感知中。我想知道它在哪些方面是有用的? 我了解remarks标签可用于提供类的额外信息,但在悬停或调用该类时,它不会在智能感知中显示。请问它在哪些方面是有用的呢?

11得票3回答
Visual Studio - 摘要标记注释 - 可选参数

当指定摘要标签注释时,是否有一种使用 <param> 标签来注明参数是可选的,例如: <param name="Mime" optional="true">,即客户端可以提供一个值或 null 值。 通过搜索引擎无法找到属性列表或允许的值。/// <summa...

8得票1回答
如何在XML注释中引用泛型类的扩展方法

什么是适用于IEnumerable接口的SingleOrDefault扩展方法的正确XML注释语法? 我的最新尝试如下: <see cref="IEnumerable{T}.SingleOrDefault{T}()"/> 警告是: XML注释中的'yourMethod'...

24得票3回答
XML注释 - 参考文献是否应该完全合格化?

基本上,什么时候(如果需要的话)才需要使用完全合格的 XML 查看参考文档: <see cref="T:MyNamespace.Sub.MyType"/> //Option 1 <see cref="T:MyType"> //Option 2 此外,对于引用.NE...

9得票2回答
XML注释用于属性/访问器

是否可以为set和get访问器添加XML注释,以便在Object Browser (VS 2010)中可见? /// <summary> /// Something about property. /// </summary> public bool IsSomet...

15得票6回答
C#编程中的XML注释技巧

早上好,下午好,晚上好或晚安(根据您所在的时区而定)。 这只是关于C#中XML注释的一般性问题。我从来没有非常重视对我的程序进行注释,我通常更喜欢用冗长的变量/属性/方法名称让代码自己说明。如果我编写的某些内容相当混乱,我会写注释,但大多数情况下我不写很多注释。 我正在阅读有关.NET、S...