9得票1回答
有没有办法在C# XML注释中保留空格?

我目前正在记录我的C#代码,并且希望能够包含一个直接显示如何调用代码的代码块。我使用嵌入到摘要中的 <code> 标签: 虽然这种方式在一般情况下是有效的,但我想保留空格(换行符、缩进)。我迄今为止尝试过以下方法: 对 <code> 标签应用了 xml:spa...

9得票9回答
代码注释:你把代码注释放在接口上还是具体类上,或者两者都有?

如何最好地记录类和接口。假设您有一个名为Foo的具体类,它派生自名为IFoo的接口。您在哪里放置方法的注释?您是否需要在接口和具体类上重复注释? 以下是注释被复制的示例: public class Foo : IFoo { /// <summary> /// T...

9得票1回答
如何明确地记录一个方法不会抛出异常。

使用C#中的XML注释,我可以记录一个方法可能会抛出异常: <exception cref="FooException">Thrown if foo is invalid.</exception> 然而,如果方法的XML文档中没有exception标签,这可能意味...

9得票2回答
通过LINQ to SQL设计器生成的类属性添加XML注释

我使用Visual Studio中的LINQ to SQL设计器创建了一个数据库对象模型。现在,我想为每个生成的属性添加XML注释,但我不知道如何在不刷新dbml文件时完成此操作。 如何实现这一目标?

9得票6回答
在.NET中使用XML注释的优点是什么?

我不理解使用XML注释的优点。我知道它们可以被转换成漂亮的文档,但是更简洁的DOxygen语法也可以实现相同的效果。在我看来,XML注释是错误的,因为: 它们使评论和代码晦涩难懂(对人类来说更难读)。 单个屏幕上可以查看的代码更少,因为“summary”和“/summary”需要额外的行。...

9得票1回答
我能否在Visual Studio中更改XML注释模板?

我希望在Visual Studio 2010提供的XML注释标准模板中添加一个或两个<tag>。当我在代码中输入///时,我希望看到新标签与默认标签一起出现在插入的注释块中。在C#环境下,我该如何做呢?

9得票2回答
XML注释用于属性/访问器

是否可以为set和get访问器添加XML注释,以便在Object Browser (VS 2010)中可见? /// <summary> /// Something about property. /// </summary> public bool IsSomet...

8得票3回答
EPPLUS添加注释导致打开Excel文件时出现错误。

我想在一个单元格添加注释,所以...我这样做: ... ExcelPackage package = new ExcelPackage(new MemoryStream()); var ws = package.WorkBook.WorkSheet[1]; ws.Cells[1, 1].A...

8得票3回答
C# XML注释复用

我正在编写一个包含许多类和函数的C#类库。这些函数做的事情几乎都是相同的。我需要为每个类中的函数参数提供非常详细的XML注释,但大多数情况下都是相同的。有没有一种方法可以重用XML注释,这样我就不必在整个程序集中重复这些XML参数定义了? 下面是我的类的一个示例: public class...

8得票1回答
XML注释未在WCF服务中显示

我有一个WCF服务,以下是我的操作合同的注释: /// <summary> /// Call to topup a card. /// </summary> /// <param name="topUp">The TopUp...