需要选择合适的语言来编写文档
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 文档, /// /// Has a clos…
如何防止 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#。 我有这样的评论: /// /// Of these Colonies, and oug…
命名空间的 XML 文档
您会为命名空间编写 xml-doc 吗? 如果是,如何以及在哪里? 我想,如果可能的话,也许是一个几乎空的文件,如下所示: /// /// This namespace conta…
C#中同步接口和实现注释的方法
是否有自动方法在接口及其实现之间同步注释? 我目前正在记录它们,并且不想手动使它们保持同步。 更新: 考虑这段代码: interface IFoo{ /// /// Co…
带有接口和实现类的 XML 文档注释
Closed. This question needs to be more focused. It is not currently accepting answers. 想要改进这个问题吗?通过编辑这篇文章来更新问题,使其…
实现类可以“继承”吗? 来自其实现的接口的 XML 注释?
好奇的问题。 我正在使用 Microsoft 的 Sandcastle 从 C# 代码中的 XML 注释生成文档。 我的几个类正在实现已经具有注释方法的接口。 我不想在接口方…
在 C# XML 文档中引用泛型类型的泛型类型?
为谓词帮助器类编写一些 XML 文档。 但我不知道我可以引用 Expression> 而不会出现语法错误。 有可能吗? 我已经尝试过: 但是我在 {T, bool}} 下看到…
如何使用 XML 文档文件
当使用带有 XML 文档文件的外部程序集时,如何让 Visual Studio 找到它? 当使用带有 XML 当有 XML 文档文件时,是否有程序或 xml 转换文件或其他东…
如何将方法描述的 XML 注释保留在单独的文件中?
这个问题源于这个问题 代码文档多少算太多? 答案之一是保留您的 xml 文档位于单独的文件中。 我真的很喜欢这个答案,因为当我查看代码时,文档的冗长…
如何在 xml 文档中引用泛型类和方法
编写 xml 文档时,您可以使用 something,这当然有效。 但是如何引用具有泛型类型的类或方法呢? public class FancyClass { public string FancyMeth…