2011-06-23 43 views
3

当我创建一个方法我用XML注释:如何显示您在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

回答

4

同样的问题Show <returns> xml tag into visual studio intellisense

简单的答案是否定的,您可以同时使用有问题的方法没有看到提示的<returns>标签内容。 <returns>标记将代替显示在文档文件中。如何创建该文件的演练步骤如下:http://www.codeproject.com/KB/XML/csharpcodedocumentation.aspx

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