如何显示您在xml注释中设置的注释文本？

Question

当我创建方法时，我使用XML注释：

/// <summary>
/// Here goes the summary
/// </summary>
/// <param name="contextId">Some text about the parameter</param>
/// <returns>Some text which describes the return value</returns>

但是当我想使用这种评论的方法时，我没有看到“返回”文本。在使用方法时，是否可以在Visual Studio中看到此文本？

我正在使用VS 2010

Answer 1

与Show <returns> xml tag into visual studio intellisense

相同的问题

简单的答案是否定的，在使用相关方法时，您无法在工具提示中看到<returns>标记内容。 <returns>标记将显示在文档文件中。有关如何创建该文件的演练位于http://www.codeproject.com/KB/XML/csharpcodedocumentation.aspx

在编写自己的代码时，您的方法摘要应该在了解返回类型的上下文中很好地理解返回的内容，例如： System.Int32.Equals(System.Int32 obj)（具有布尔返回类型）的摘要是返回一个值，该值指示此实例是否等于指定的System.Int32值。