如何使Visual Studio智能感知显示XML注释中的备注部分？
当编写代码时，我非常喜欢Visual Studio 2010（专业版）的Intellisense功能，特别是能够查看正在使用的类型的XML注释。 （请参阅Microsoft的文档）。到目前为止，这个功能还可以使用。 然而，XML代码注释的备注部分未显示。 我认为这是一个非常有用的功能，因为通...
VB.NET和Visual Studio Intellisense中的多行XML注释
我正在尝试在VB.Net的XML注释中添加换行符。我已经阅读了两篇关于C#的其他帖子， C#中的XML多行注释-我做错了什么？ 为智能感知添加注释的换行符 但是建议使用或标签不起作用。这个， ''' <summary> ''' <para>Lin...
C#编程中的XML注释技巧
早上好，下午好，晚上好或晚安（根据您所在的时区而定）。 这只是关于C＃中XML注释的一般性问题。我从来没有非常重视对我的程序进行注释，我通常更喜欢用冗长的变量/属性/方法名称让代码自己说明。如果我编写的某些内容相当混乱，我会写注释，但大多数情况下我不写很多注释。 我正在阅读有关.NET、S...
在XML文档中使用< >字符的see cref用法？
可能是重复问题： 如何在XML文档中引用泛型类和泛型方法 我一直在使用 see cref 标签，它非常好用，但现在我需要在 see cref 中包含一个字符串数组的泛型列表，但是文档没有正确呈现。 /// <returns>A <see cref="Li...
禁用自动生成的代码/文件夹/命名空间的警告信息
我喜欢在C#中拥有干净、"0警告"的项目。这包括我的项目中为每个公共属性和类添加XML注释。 现在我使用实体框架和迁移（先写代码）。迁移是通过使用 "Add-Migration" 创建的，这会导致自动代码生成在Migrations文件夹中(标准行为)。我可能想/需要稍微修改这些类，但不想为创...
在代码注释中引用TFS工作项
在Visual Studio（2012+）中，我希望能够从代码注释中点击到TFS工作项的引用。 是否有简单的方法可以实现这一点，并且是否还可以从函数体内部的注释中实现（不是函数的摘要）？ 所以我想要类似这样的效果：/// <summary> /// Example of a su...
你应该在私有方法上编写XML注释吗？
因此，我在我的代码中使用XML注释来帮助解释公共方法和公共成员。另一位开发人员提到我的部分方法没有XML注释。我的规则是：如果是public或protected，则添加XML注释；如果是private，则不添加。这个规则听起来合理吗？或者有什么原因需要对私有方法添加XML注释吗？
C#中替代XML文档注释的方法
当问及C#代码文档注释的惯例时，答案总是指向使用XML注释。微软自己也推荐这种方法。https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentati...
你应该为接口、具体实现还是两者都写XML注释？
我想知道应该在哪里应用我的XML注释。我应该把更通用的XML注释放在接口上，把更详细的注释放在实现类上吗？就像这样：public interface IObjectRepository { /// <summary> /// Returns an object...
C#中位置记录的属性文档注释
如果我有这样的位置记录：public record Version(int Major, int Minor); 看起来我只能提供一个像这样的<summary>文档: /// <summary> /// Version record /// </summary&...