34得票6回答
如何在VS2012中为C#项目禁用特定的警告?

我正在尝试在VS2012中的C#项目构建过程中生成部分XML文档。 当我在项目->属性->生成中勾选XML文档文件选项时,对于每个缺少文档的公共成员,我会收到构建警告。 由于我们编译时将警告作为错误处理,这会阻塞构建。 这个问题建议通过禁用某些警告来解决,但我无法弄清楚如何在VS2012中完...

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

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

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

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

15得票1回答
在XML文档中使用< >字符的see cref用法?

可能是重复问题: 如何在XML文档中引用泛型类和泛型方法 我一直在使用 see cref 标签,它非常好用,但现在我需要在 see cref 中包含一个字符串数组的泛型列表,但是文档没有正确呈现。 /// &lt;returns&gt;A &lt;see cref="Li...

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

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

8得票3回答
TypeScript已经支持XML文档吗?

TypeScript已经支持XML文档吗?目前似乎还没有,但是我可能忽略了一些东西。 我想要的是这样的: export class Point { /// &lt;summary&gt;This is a Point class.&lt;/summary&gt; cons...

16得票2回答
如何编写XML注释以避免在摘要和返回标记之间重复自己?

当一个方法的目的是计算并返回一个值时,我通常会这样记录它:/// &lt;summary&gt; /// Calculates the widget count. /// &lt;/summary&gt; /// &lt;param name="control"&gt;The control ...

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

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

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

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

30得票3回答
在Visual Studio IntelliSense中显示<returns> XML标记

我在我的一些方法中添加了&lt;returns&gt; XML 标签,但是在 IntelliSense 中看不到其内容。 这是我的代码:/// &lt;summary&gt; /// we all live in a yellow summary /// &lt;/summary&gt; /...