Tag: xml documentation

如何在C＃中评论/记录覆盖？: 有时我会覆盖基类中的方法。有时我甚至用空方法覆盖它们，因为我想要的是防止这种行为。在过去，我会写这样的东西来表明绕过基本方法的意图： protected override void OnMouseUp(MouseEventArgs e) { // base.OnMouseUp(e); } （我知道注释的代码行是一件坏事。我曾经这么做过）但我想做得更好：如何记录覆盖的意图？特别：我在override的XML （？）文档中写了什么？

接口和类方法的注释应该如何不同: 在使用C＃中的Web客户端软件工厂（WCSF）处理ASP.net Web应用程序时，我遇到了这种困境，同样适用于其他平台和语言。我的情况是这样的：我正在为基于WCSF范例的每个网页/用户控件定义一个I View界面，然后让页面类实现I View界面，基本上实现界面中定义的每个方法。当我尝试在方法级别添加xml文档时，我发现自己基本上重复了接口方法的相同注释内容，以及它在实现类中的反向部分。所以我的问题是：接口方法的文档内容和相应的类方法之间是否存在一些实质性的区别？他们应该在不同方面强调什么？有人告诉我，接口方法注释应该说该方法应该做什么，而类方法注释应该说“它是如何做的”。但我记得在之前的某处读过方法级别注释应该只说这个方法应该做什么，而不是方法的实现细节，因为实现不应该是方法用户的关注，它可能会改变。

XML文档问题中的generics: 我试图在我的类XML文档中包含一个代码片段，但编译器抱怨xml元素没有关闭！这是我想要实现的目标 /// /// Method documentation here… /// /// /// /// This class should be used as follow: /// /// ************** PROBLEM IN NEXT LINE ******************** /// MyClass class = new MyClass(); /// /// public class MyClass{ …. } 我试图用/// MyClass class = new MyClass{String}(); 替换代码片段/// MyClass class = new MyClass{String}(); /// MyClass class = […]

在XML文档中使用带字符的cref？: 可能重复：如何在xml文档中引用generics类和方法我一直在使用see cref标签，它工作得很好，但现在我需要在see cref中包含一个string []的通用列表，但是文档没有正确呈现。 /// A <see cref="List” /> that ……. 我认为它与有关，也许[] 这是允许的，是否有解决方法？

如何在c＃xml docs中引用枚举常量: 我想记录枚举类型字段的默认值： /// /// The default value is . /// public Orientation BoxOrientation; 编译器警告它无法解析引用。前缀F：或M：使编译器静音，但E：也可以，所以我不确定哪个前缀是正确的。

仅为公共成员提取xml注释: 我正在使用xml注释来记录我的组件的公共以及内部和私有成员。我想将生成的文档xml文件与组件程序集打包在一起，以便为最终产品启用“丰富”（例如，使用方法，exception和参数描述）Visual Studio Intellisense。它的问题是C＃编译器为所有内容（包括内部类，方法，内部枚举的私有字段等）创建文档条目，并且似乎没有切换到“仅公共成员”模式。现在我不想在每个文件中使用XX方法查看超过50个文件，并删除私人和内部成员的所有注释。即使我这样做，我可能也不会在auto-gen’d资源文件上取得太大成功，因为这些强类型资源类会自动注释而非公开。我的问题是：是否有一些选项/标志我忽略了？如果不是，是否有一些工具可以帮助将公共成员与其他成员分开（在我开始编写代码之前）？

如何为CHM或HTML文件生成C＃文档？: 有没有办法直接从Visual Studio中的代码文档生成可读文档文件？（也考虑2010年）代码示例： /// /// Convert a number to string /// /// An integer number to be converted to string /// Number as string /// /// /// var s = MyMethod(5); /// /// /// In case it can’t convert /// /// Whatever /// public string MyMethod(int number) { return number.ToString(); }

让svcutil从C＃文件中获取文档？: 伙计们，我正在创建一个新的WCF服务，并从我的服务界面开始。看起来像： public interface ISomethingService { /// /// some description /// /// 2.13.0 /// 2009 by myself /// Marc Scheuner /// The request object [OperationContract] SomethingResponse GetList(SomethingRequest request); } 现在，我还在另一个描述SomethingRequest和SomethingResponse消息的文件中创建了一些数据协定。我编译了我的项目并启动了svcutil.exe以从DLL中提取元数据（WSDL和XSD） – 但我似乎无法弄清楚是否有办法将我的所有注释和解释都放到WSDL / XSD中/节点。我是否对另一个不起眼的svcutil.exe参数视而不见，或者真的没有办法在元数据中自动生成这个文档？编辑：好的，根据Marc Gravell的回答，注释和文档字符串不在编译的DLL中，也不在MEX元数据交换协议上可用（可惜！）。那么：如果您需要向第三方提供访问您服务所需的信息，您如何记录您的WCF服务？是否存在“NService”或“Sandcastle for WCF”工具，它将扫描我的WCF服务库并从源代码构建WSDL和XSD，包括注释？似乎无法找到很多工具和方法来做到这一点 – 令我惊讶的是，老实说…. 渣

如何在C＃/ VisualStudio 2008中导出代码文档？: 我总是使用C＃xml语法为类和方法编写好的代码注释。我一直希望以后能够轻松地将它们导出。今天我实际上必须这样做，但我很难找到方法。有什么我想念的吗？我想去菜单 – >构建 – >构建代码文档，但没有选项可以做到这一点。

如何在VS 2010中为变量/字段/列表编写注释/文档？: 有 /// ///This is summary for some class or method /// 类或方法的文档。但是如何为简单的变量或列表编写这个？我使用Visual Studio 2010，当我将鼠标hover在一些列表，属性或者我希望看到的某种摘要（在那个小工具提示中）时，我已经写过那个特定的东西。 /// ///always use this list! List beer = new List(); 编辑：好的，我们已经发现，它像往常一样在您的class级中发表评论但是OUTSIDE方法或function!! 有什么办法在方法中记录/评论吗？ public class BeerForall { /// /// it works here /// public List beer = new List(); public String giveBeer() { /// is not working, u can not […]