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

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

7得票2回答
接口和类方法的注释应该有什么区别?

我在使用C#和Web Client Software Factory(WCSF)开发ASP.net web应用程序时遇到了这个问题,其他平台和语言也可能会遇到同样的问题。我的情况是这样的: 我基于WCSF范例为每个网页/用户控件定义一个IView接口,然后让页面类实现IView接口,基本上实...

17得票5回答
如何防止Visual Studio锁定bin目录中的xml文档文件?

我的Visual Studio解决方案包括一个Web应用程序和一个单元测试应用程序。我的Web应用程序使用log4net。我想能够使用命令行中的msbuild来构建我的解决方案。但是,每当我从命令行构建解决方案时,我会收到构建错误,因为它无法将log4net.xml复制到测试项目的bin目录中...

7得票1回答
DRY XML 注释

当提供同一方法的多个重载时,我经常不得不重复方法的描述,这违反了DRY原则并增加了维护成本: /// <summary> /// Frobnicates all foos read from the given reader. Frobnication is a /// proc...

15得票2回答
我能否将XML文档从接口传播到其实现?

我需要将一个基类的XML文档或接口的实现传播给派生类或实现类。 使用Resharper可以实现吗?

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

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

107得票5回答
如何在Web Api的Xml文档中包含来自主项目以外的文档?

似乎只有处理您的Web Api项目中所有API类型都是一部分的情况下,才能启用XmlDoc集成的文档。特别是它讨论了如何将XML文档重定向到App_Data/XmlDocument.xml并取消注释配置中将使用该文件的行。这仅隐含地允许一个项目的文档文件。 然而,在我的设置中,我在一个公共“...

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

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

9得票2回答
NuGet包未将XMLDoc文件随着dll一起复制到bin目录下

我正在使用NuGet GUI,并尝试将XML文件与DLL一起分发,以便在DLL之外提供帮助。当我在任何项目中安装包时,它成功地添加了DLL引用,但未在添加包的项目的bin文件夹中生成XML文件。XML文件位于packages\\lib\.XML文件夹中。 如图所示,NuGet Package...

47得票7回答
在C#的XML文档中如何引用一个泛型类型的泛型类型?

我正在为一个谓词帮助类编写一些 XML 文档。但是我无法弄清楚如何在不出现语法错误的情况下引用 Expression&lt;Func&lt;T, bool&gt;&gt;。这是否可能?我尝试过以下代码: &lt;see cref="Expression{Func{T, bool}}"/&gt...