标签: xml-documentation

我使用ILMerge将我的几个C#项目DLL合并到一个DLL中,用于整个解决方案.我让每个项目为Intellisense生成其文档的.XML文件,当我尝试使用我的合并DLL作为另一个解决方案的参考时,我无法显示这些注释.我将这些文件都放在同一目录中:

• MergedProjectDlls.dll
• Project1.XML
• Project2.XML
• Project3.XML
• Project4.XML

我尝试将单个项目XML文件重命名为MergedProjectDlls.XML,然后在Visual Studio中删除并重新添加引用,但是Intellisense仍然没有接受我在已重命名的项目XML文件中存在的注释.

我希望以某种方式将所有这些项目XML文件合并到一个名为MergedProjectDlls.XML的文件中.那可能吗？当Intellisense与MergedProjectDlls.dll位于同一目录时,它会自动接收吗？

编辑:刚刚在MSDN上找到了这个:

要使用生成的.xml文件与IntelliSense功能一起使用,请让.xml文件的文件名与要支持的程序集相同,然后确保.xml文件与程序集位于同一目录中.因此,在Visual Studio项目中引用程序集时,也会找到.xml文件.

并且:

除非使用/ target:module进行编译,否则file将包含指定包含编译输出文件的程序集清单的文件名的标记."

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

我有一个库的源代码,每个变量,方法等都在那里评论使用

/// <summary>
/// 
/// </summary>
/// <param name="paramname"></param>

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

我在C#项目中有许多多行样式注释,当项目选项设置为输出XML文档文件时,它们都会触发警告XML注释不会放在有效的语言元素上.在Visual Studio 2010中观察到此行为.

如果没有将所有这些注释更改为单行样式注释,我可以做些什么来防止这些警告被触发？

减少的例子:

public class Foo
{
    /// <summary>
    /// Does something.
    /// </summary>
    public void DoSomething()
    {
        /**
         * Do something interest here.
         */
    }
}

我正在从 Ebay 请求一些 XML，但返回的 XML 对于 VBA 调试窗口来说太长，因此我需要将返回的 XML 转储到文件中 - 作为一个 n00b 并在黑暗中掌握，我可以找人帮助我获取 XMLHttpRequest.responseXML.XML 内容并将其放入文件的正确语法。这是我的代码（全部有效 - 我只需要写入文件的行）

Dim fso As Object
Set fso = CreateObject("Scripting.FileSystemObject")
Dim oFile As Object
Set oFile = fso.CreateTextFile("Z:\AccessData\Temp.xml")     

XMLHttpRequest.send (body)
objxmldoc.loadXML (XMLHttpRequest.responseXML.XML)
Debug.Print XMLHttpRequest.responseXML.XML ' valid XML showing at this point

我正在尝试为我编写的API编写一些文档.C#编译器不会为此特定方法生成文档.它说XML文档格式不正确.

你能帮我辨认一下它的不良形象吗？我已多次检查代码,但我找不到问题.不幸的是,C#编译器不会告诉我哪一行导致了问题.

/// <summary>
/// Given a value pertaining to a specific culture, let's call it the value culture, 
/// this method returns a sequence of resource keys and their values in another culture, 
/// let's call this the desired culture, based on a search of matching values in the value culture. 
/// The search can further be filtered based on metadata.
/// </summary>
/// <typeparam name="T">Represents the System.Type of value to look up and return.</typeparam>
/// <param name="value">The value …