8得票2回答
如何在XML注释中指定类型<return>注释

在我的C# XML注释的&lt;return&gt;注释中,我希望输出(我正在使用Sandcastle)指定返回的类型,但我无法找到如何实现这一点。 伪代码示例: ///&lt;summary&gt; ///Serves as a hash function for a particula...

8得票4回答
使用Visual Studio查找丢失的XML注释内容

我们的C#源代码中有很多注释,但很多都缺少实际内容,就像这样: /// &lt;summary&gt; /// &lt;/summary&gt; 或者这样: /// &lt;summary&gt; /// /// &lt;/summary&gt; 或者是这样的: /// &lt;...

8得票14回答
代码文档:太多是否有害?

.NET源代码中文档的数量应该是多少? 背景:我继承了一个庞大的代码库,我在SO上发布的一些其他问题中已经提到过。这个代码库的一个“特点”是上帝类(God Class)——一个单一的静态类,包含超过3000行代码,涵盖几十个静态方法,它们从Utilities.CalculateFYBased...

8得票2回答
XML注释在发布模式下是否会保留?

一方面,MSDN 表示: XML doc comments 并非元数据,不包含在编译的程序集中... 但另一方面,在 Visual Studio 中,Intellisense 会为 .net 类库等显示它们(例如,当您悬停在 Int32 上时)。 为避免误解,我指的是这些: ///...

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

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

8得票1回答
将Doxygen转换为XML注释

我们有一个C#项目,由于历史原因,在同一段代码中同时使用Doxygen和Visual Studio风格的注释。 是否有人尝试过系统地将一个标准翻译成另一个标准,最好是到常见的XML子集? 我想编写一个脚本来覆盖最常见的功能,但我不想重复造轮子。

7得票4回答
C# XML代码注释文件引用

在XML代码注释中,是否有用于文件引用的标签?该文件是SQL脚本文件。 只是想知道是否有比这更好的方法。 ///&lt;summary&gt; ///please have a look at c:\code\project1\sql\file1.sql ///&lt;/summary&gt...

7得票1回答
Visual Studio 2010 SDK -- 如何在XML注释组旁边放置修饰?

我在寻找如何获取XML注释的NormalizedSnapshotSpanCollection,但是Visual Studio SDK参考文档并没有提供很好的帮助。 我想在这些注释旁边放置一个图标... 我不想在每一行旁边都放一个图标,而只想在每个组的第一行旁边放置一个图标... ///&l...

7得票3回答
在Vb.Net中自动生成XML注释

最近我从c#.net转向vb.net进行编码。 在c#中,我可以在任何类/方法上方按下///,Visual Studio会自动为我生成xml注释内容。 例如: /// &lt;summary&gt; /// /// &lt;/summar...

7得票1回答
XML注释 - 异常在智能感知中不显示

我有一个方法,在命名空间MyApp.Domain下抛出了一个异常。我有一些自定义异常也在命名空间MyApp.Domain.Exceptions下。所以,我的情况是这样的: using MyApp.Domain.Exceptions using System; namespace MyApp...