问题标签 [xml-documentation]

基本上，我有以下代码：

我的项目.XML

Sandcastle 的内置输出：

警告：ShowMissingComponent：M:MyProject.MyDictionary`2.System#Collections#Generic#ICollection{T}#Clear 缺少文档

所以，不知道到底该怎么做。我确实让我的 Sandcastle 构建选项包含显式实现，这就是它在文档中为它们创建页面的原因，但它似乎无法弄清楚我确实为这个方法创建了 XML 注释。奇怪的是，该void MyDictionary<TKey, TValue>.IDictionary<TKey, TValue>.Add(TKek key, TValue value)方法被标识为具有 XML 注释。事实上，所有隐式实现的 ICollection> 方法都给 Sandcastle 带来了问题。有什么帮助吗？

是否有 JavaScript 的注释文档格式和生成 HTML 文档的这种格式的处理器？

目前，我正在使用 VSDoc xml 注释在开发时提供 IntelliSense 帮助，但据我所知，没有此类注释的文档生成器。因此，或者我的问题可能听起来像：是否有任何实用程序可以将 VSDoc 注释从 JavaScript 文件转换为 HTML？

如何为 .NET 函数中的 c# 方法添加 XML 文档。

例子

Guid.NewGuid();

当用户按下 . 关键他得到了关于函数 NewGuid 的帮助。

我有一个 GetDocsInfo 类，它具有 getDocTag 之类的功能，我需要类似的功能，是否需要添加任何元数据类型的东西，就像属性一样

我正在使用 Sandcastle 帮助文件生成器将我的 C# XML-DOC 文件输出为网站格式。如何从命令行完成相同的操作，以便在构建实际项目时将其添加为 Visual Studio 中的构建事件？

最终目标是在我构建 Visual Studio 项目时构建网站帮助文件内容。

有

类或方法的文档。但是如何为简单的变量或列表编写这个？

我使用 Visual Studio 2010，当我将鼠标悬停在某个列表、属性或我希望看到的某种摘要（在那个小工具提示中）时，我已经写了那个特定的东西。

编辑：好的，我们发现，只要你在课堂上发表评论，但在方法或函数之外，它就可以正常工作！

有什么方法可以在方法中记录/评论吗？

I have a problem with modifying xml file when i first load and then save it with same file path and name. Below is my code. The error is "Access to the path C:\MyApp\Web.config is denied. If i change the path of the xdoc.Save to be different from xdoc.Load, then it will be ok. What is your recommandation to solve this problem? If possible, i need to modify the existing xml file(meaning xml file for loading and saving is the same path).

Thanks in advance.

在 Visual Studio 中，如何将默认的 XML 摘要注释片段从三行更改为一行？

目前它在我输入时提供了这个片段///：

我想要这个较短的片段：

我的摘要通常很简短，多余的 2 行是不必要的。

是否有此配置设置或一些可自定义的代码/自定义插件来解决此问题。

我将使用 codeproject.com 的框架，包中有一个 .dll 文件和 .xml 文件。Add Reference...我使用并浏览它的位置将 dll 文件添加到我的项目中。它被添加到引用中，我可以在我的代码中通过using ....

我有两个问题：

1. 包中有一个 XML 文件，似乎是对方法和类似内容的注释。我怎么能用这个？（所以当我从该框架中键入方法名称时，它的描述会弹出？）

2. 如何确保在为我的项目构建安装时，dll 文件将包含在其中？

可能重复：
如何让 XML 注释出现在不同的项目 (dll) 中？

我有一个库的源代码，每个变量、方法等都使用

我已经构建了这个项目，现在我想在另一个项目中将它用作 dll 文件，但是当我添加引用时，我看不到变量的描述等。我做错了什么？

• 我正在使用代码合同版本：1.4.40602.0
• 我复制了必要的内容和转换文件
• Sandcastle 根据我的合同要求输出例外情况

示例代码：

结果输出（在我的文档中）：

这还不错，但是我想知道是否有办法自定义条件的文本？我试图添加一条用户消息Contract.Requires<ArgumentNullException>(obj != null, "obj is null.");，但这并没有解决任何问题。

过去，我不得不为异常编写自己的 xml 文档部分。我是否必须再次这样做才能得到我需要的东西？

免责声明：由于 Code Contracts（目前）是一个 DevLabs 项目，这可能会改变，但我想知道它现在是否已经可用......如果没有，我一定会建议它。