Referencing constructors in XML comments

G

Guest

Hi

In the XML comments for a property of one of my classes I'd like to be able to reference a particular constructo
(actually, even the constructor summary page would be a start) of that class e.g

/// <summary
/// Check <see cref="MyClass.Constructor">this</see> constructor
/// </summary
public string MyProperty {...

Cheers, Wodger.
 
J

Jeffrey Tan[MSFT]

Hi Wodger,

Thanks for posting in this group!!

I have review your issue, I will spend some time to find the result for
you. I will reply to you ASAP.

Thanks for your understanding.

Best regards,
Jeffrey Tan
Microsoft Online Partner Support
Get Secure! - www.microsoft.com/security
This posting is provided "as is" with no warranties and confers no rights.
 
J

Jeffrey Tan[MSFT]

Hi Wodger,

I have figure this out. You should do like this:

/// <summary>
/// Check <see cref="MyClass()">this</see> constructor.
/// </summary>
public string MyProperty {...}


Please apply my suggestion above and let me know if it helps resolve your
problem.

Thank you for your patience and cooperation. If you have any questions or
concerns, please feel free to post it in the group. I am standing by to be
of assistance.

Best regards,
Jeffrey Tan
Microsoft Online Partner Support
Get Secure! - www.microsoft.com/security
This posting is provided "as is" with no warranties and confers no rights.
 
G

Guest

Hi Jeffrey,

Perfect - many thanks indeed!!!

As a slightly expanded example for anyone else interested, to access the second of these constructors:

public MyClass() {...}
public MyClass(MyObject o) {...}

I specified the following reference in my comment (for MyProperty in MyClass):

/// <summary>
/// Check <see cref="MyClass(MyObject)">this</see> constructor.
/// </summary>
public string MyProperty {...}

Cheers, Wodger.
 
J

Jeffrey Tan[MSFT]

Hi Wodger,

Thanks very much for your feedback!

I am glad my reply works for you. :) Also, thanks for your sharing
knowledge with the community!

Cheers!!

Best regards,
Jeffrey Tan
Microsoft Online Partner Support
Get Secure! - www.microsoft.com/security
This posting is provided "as is" with no warranties and confers no rights.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top