接口和类方法的注释应该如何不同
在使用 C# 中的 Web 客户端软件工厂 (WCSF) 开发 ASP.net Web 应用程序时,我遇到了这种困境,同样的情况也适用于其他平台和语言。我的情况是这样的:…
Visual Studio 对象浏览器忽略 XML 注释格式
在关于方法和类的 .NET XML 注释中,我尝试在 块中提供使用示例。当我使用 Sandcastle 使用 XML 文档生成 .chm 文档文件时,它的格式始终很好,并且遵…
如何在使用 XSD.exe 生成的 C# 类中包含 xsd:documentation?
我正在使用 xsd.exe 生成来自 xsd 文件集合的 C# 类。 xsd 文件使用 标记来包含有用的描述。示例: <xsd:complexType name="AddressType"> <xsd…
合并 DLL,Intellisense 不拾取单独的 XML 文档文件
我使用 ILMerge 将多个 C# 项目 DLL 合并为整个解决方案的单个 DLL。我让每个项目都为 Intellisense 生成其文档的 .XML 文件,当我尝试在另一个解决方…
Sandcastle 区分调试版本和发布版本吗?
我今天启动了 Sandcastle Help File Builder 来为我的解决方案生成文档,其中包含大约十几个项目。由于我只想为发布构建(不包括我的所有测试项目)生…
如何记录 XML 文件的结构
当谈到记录 XML 文件的结构时...... 我的一位同事在 Word 表格中进行了这项工作。 另一种方法将元素粘贴到 Word 文档中,并带有如下注释: <learnin…
有没有一个工具可以将 Javadoc 转换为 C# XML 文档?
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers. 要求我们推荐或查找工具、库或最喜欢的…
如何让 XML 注释出现在不同的项目 (dll) 中?
/// <summary> /// This method does something... /// </summary> public void DoSomething() { // code... } 当在不同的 .dll 中使用该方法…
需要选择合适的语言来编写文档
Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not …
是否有任何标准可以直观地描述 XML 文件结构或模式?
Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not …
C#、XmlDoc:如何引用方法重载
如果我有这两种方法 public Foo Get(string bar) { ... } public Foo Get(int bar) { ... } 并在不同的方法上编写这段 xml 文档, /// <summary> …
如何防止 Visual Studio 锁定 bin 目录中的 xml 文档文件?
我的 Visual Studio 解决方案包括一个 Web 应用程序和一个单元测试应用程序。 我的 Web 应用程序使用 log4net。 我希望能够从命令行使用 msbuild 来构…
Visual Studio:针对私有和内部成员缺少 XML 文档发出警告
我正在使用 Visual Studio 2005 (VS.8.0),并且我希望强制执行所有类成员(而不仅仅是公共成员)都被记录的要求。 虽然设置 Visual Studio 在公共、受…
如何让 Emacs fill-paragraph 处理我的 C# 模块中的内联 XML 代码文档?
这个问题类似于 获取 Emacs fill-paragraph可以很好地处理类似 javadoc 的注释,但适用于 C#。 我有这样的评论: /// <summary> /// Of these Col…
命名空间的 XML 文档
您会为命名空间编写 xml-doc 吗? 如果是,如何以及在哪里? 我想,如果可能的话,也许是一个几乎空的文件,如下所示: /// <summary> /// This n…