Posted 5 months ago by Gavin Huet
Version: 24.1.0
Avatar

Hi,

If I have a property or method that has an XML Comment, the intellisense shows the Summary tag as I hover over it which is expected.
However, it does not display the "remarks" text which can be useful information to display to a user.

In the example below the remarks "This will not be saved." is not displayed as part of the intellisense.

''' <summary>
'''  The Tag property can be used to attach another value or object to this object.
''' </summary>
''' <remarks>
'''  This will not be saved.
''' </remarks>
Public Property Tag() As Object
  Get
    Return mTag
  End Get
  Set(value As Object)
    mTag = value
  End Set
End Property

Visual Studio does display the information from the "remarks" node as well as other nodes.

Is there anyway this can be displayed too?

Kind regards

Gavin

[Modified 5 months ago]

Comments (5)

Answer - Posted 5 months ago by Actipro Software Support - Cleveland, OH, USA
Avatar

Hi Gavin,

Yes we will update our IntelliPrompt tips to include remarks sections if available.  This will be in the next build.

Please note that Microsoft may exclude the remarks sections from some of the VS-generated doc comment .xml files.  Therefore this feature might only work with project references and not all assembly references.


Actipro Software Support

Posted 5 months ago by Gavin Huet
Avatar

Thank you!

The latest build of this product (v24.1.1) was released 29 days ago, which was before the next post in this thread.
Posted 27 days ago by Gavin Huet
Avatar

Hi,

We have installed v24.1.1 where this fix is mentioned but have not been able to see it working anywhere.

I have taken the Sample Browser and added a reference to an assembly that has a XML Remark but intellisense does not pick it up. The assembly XML file is correct and I can see the remark there:

<member name="P:Intersoft.ISCreditBureau4.ISCreditEnquiryResponse_ABNLookup_Business.NameResolved">
<summary>
The Resolved Name of the item.
</summary>
<returns>
A String value.
</returns>
<remarks>
Either the Company Name if it is a company, or the individual's name.
</remarks>

Is there any example of how you are seeing it work?

Thanks

Gavin

Answer - Posted 27 days ago by Actipro Software Support - Cleveland, OH, USA
Avatar

Hi Gavin,

Thanks for reporting this.  I apologize for the mistake, but it appears there was a bug in having it show for type members.  We've just corrected that for the next maintenance release.


Actipro Software Support

Posted 26 days ago by Gavin Huet
Avatar

Thank you.

Add Comment

Please log in to a validated account to post comments.