c# - 在 C# 中设置智能支持功能的弹出帮助

Question

正如我们在 Visual Studios 的智能支持中看到的那样，任何属于 Microsoft 编写的代码的一部分都有一个详细信息部分，它提供有关变量、事件、函数等功能的信息，作为弹出式帮助。我们编写的函数仅提供有关要传递的预期变量的信息。有人可以帮我找出如何为用户编写的代码的详细信息部分编写信息吗？

谢谢!

Answer 1

我怀疑您正在寻找 XML documentation .例如:

/// <summary>This method does something funky.</summary>
public void Foo()
{
}

在您的方法声明上方键入///以使 Visual Studio 为您创建框架。如果您想将文档与库一起分发，则需要在项目属性中打开 XML 生成。您通常应该将 XML 文件命名为与 DLL 相同的名称，例如Acme.MyProject.dll 将在 Acme.MyProject.xml 中有文档。