30得票2回答
在Visual Studio XML文档中同时使用<value>和<summary>标记的目的

我正在使用VS 2012中的C#编程,为我的代码添加XML文档,并意外开启了一个StyleCop规则(SA1609),该规则“验证公共或受保护属性是否包含具有值标记的文档头”。 还有另一个规则(SA1604,这次是故意打开的),它“验证文档头是否包含格式正确的摘要标记”。 然而,我很难看出...

29得票6回答
如何记录XML文件的结构

在记录XML文件的结构时... 我的一位同事使用Word表格。 另一个将元素粘贴到带有此类注释的Word文档中:&lt;learningobject id="{Learning Object Id (same value as the loid tag)}" xm...

27得票4回答
使用 Markdown 进行源代码文档编写

我正在寻找一种替代C#的XML源代码文档,因为XML本质上引入了很多噪音,这让人感到疲惫并需要更多的工作来编写:/// &lt;summary&gt; /// This is text of importance. Linking to /// &lt;see cref="AnotherCla...

26得票4回答
记录 F# 代码

在一个只有一个构造函数的C#类中,我可以添加类摘要XML文档和构造函数XML文档: ///&lt;summary&gt; ///This class will solve all your problems ///&lt;/summary&gt; public class Awesome {...

24得票3回答
如何在C#的<seealso>标签中引用方法重载?

我在MSDN中看到了像“CompareOrdinal Overloads”这样的链接。我该如何在C#中编写这样的链接? 我尝试过:&lt;seealso cref="MyMethod"&gt;MyMethod Overloads&lt;/seealso&gt; 但编译器给我一个警告,说这个方...

24得票6回答
如何在VS 2010中为变量/字段/列表编写注释/文档?

有一个问题///&lt;summary&gt; ///This is summary for some class or method ///&lt;/summary&gt; 我需要查看关于类或方法的文档。但是如何为简单变量或列表编写文档? 我使用Visual Studio 2010,当我悬...

22得票2回答
如何在C# XML文档中引用枚举常量

我想记录枚举类型字段的默认值:/// &lt;summary&gt; /// The default value is &lt;see cref="Orientation.Horizontal" /&gt;. /// &lt;/summary&gt; public Orientation Bo...

21得票7回答
如何在C# / VisualStudio 2008中导出代码文档?

我一直都养成用C#的xml语法写好类和方法注释的习惯,因为我一直期望能够轻松地将它们导出。 今天我需要导出注释,但是我无法找到方法。我应该怎么做呢?我想在“菜单-生成-生成代码文档”中进行操作,但是那里没有这个选项。

20得票6回答
提取公共成员的xml注释

我正在使用XML注释来记录组件的公共成员、内部成员和私有成员。我想将生成的文档XML文件与组件程序集打包在一起,以便在最终产品中启用“丰富”的(例如带有方法、异常和参数说明)Visual Studio IntelliSense。问题是C#编译器会为所有内容创建文档条目(包括内部类、方法、内部枚...

19得票4回答
如何使用XML文档文件

当使用带有XML文档文件的外部程序集时,我如何让Visual Studio找到它? 当有一个XML文档文件时,是否有一个程序或XML转换文件之类的工具可以以更好的方式查看它?不一定像MSDN文档查看器那么复杂,但至少比纯XML格式更好看...