296得票5回答
如何在C# .NET文档中添加换行符

这应该会容易得多... 我想在我的代码的XML文档中添加一个"编码"换行符。/// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. &...

252得票8回答
如何在XML文档中引用泛型类和方法

当编写XML文档时,您可以使用<see cref="something">something</see>,这当然有效。但是如果要引用具有泛型类型的类或方法,该怎么办? public class FancyClass<T> { public string...

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

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

106得票9回答
在C#中同步接口和实现的注释方式

有自动方式可以同步接口和实现之间的注释吗?我目前正在为它们都编写文档,但不想手动保持同步。 更新: 考虑下面的代码:interface IFoo{ /// <summary> /// Commenting DoThis method /// </sum...

81得票1回答
我该如何在XML文档中引用C#关键字?

<see cref="switch" /> 的用法是不正确的,会导致编译警告: XML comment on ... has syntactically incorrect cref attribute 'switch'/// <summary>Provides bas...

67得票2回答
哪个C# XML文档注释标签用于“true”、“false”和“null”?

哪个C# XML文档注释标记用于字面值true,false和null? 在微软自己的文档中,这些字面值以粗体文本出现。例如,ArrayList.IsFixedSize属性的文档如下所示: true表示ArrayList具有固定大小; 否则为false。默认值为false。 None ...

61得票8回答
一个命名空间的XML文档说明

你会为一个命名空间编写 XML 文档吗?如果是,应该如何编写以及在哪里编写? 我认为,如果可能的话,可以创建一个几乎为空的文件,就像这样:/// <summary> /// This namespace contains stuff /// </summary> nam...

58得票4回答
如果一个摘要作为引用添加进来,它不会在程序集中显示。

我在C#中创建了一个“类库”,其中有许多带有概述(XML文档注释)的函数。 例如:///<summary> ///Adds the two numbres ///</summary> public void Add() { //statements } 如果我...

47得票1回答
SHFB的IntelliSenseComponent的输出文件夹有哪些规则适用?

Noda Time存在一个问题,它发布的XML文档文件包含所有的内部和私有成员,这很遗憾。 幸运的是,Sandcastle Help File Builder有一个自定义构建组件-IntelliSenseComponent - 可以完全解决这个问题...理论上。不幸的是,我无法弄清楚如何正确...

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

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