Documenting members of members in C# XML-Comments

Asked Dec 14 '19 at 21:28

Active Dec 15 '19 at 22:21

Viewed 173 times

How do you document members of members in C# XML-Comments with the <see cref=".." tag?

I'm trying to document them the same way as type members, but it's giving me the warning "XML comment has cref attribute '...' that could not be resolved"

Here's the documentation comment in question:

/// <exception cref="ArgumentException">Thrown if <paramref name="namelistInstance"/> is not an instance of <see cref="Parent.UnderlyingType"/></exception>

Where Parent is a member of the class this comment is in, and UnderlyingType is a member of Parent.

A shortened version of the code:

public class Class1
{
    public Class2 Parent;

    /// <summary><see cref="Parent.UnderlyingType"/></summary>
    public void Method() {}
}

public class Class2
{
    public Type UnderlyingType;
}

edited Dec 15 '19 at 22:21

asked Dec 14 '19 at 21:28

blenderfreaky

So basically you want to show the Parent and Basetype in your cref? – panoskarajohn Dec 14 '19 at 22:00
No, I want to show a member of the member Parent. – blenderfreaky Dec 14 '19 at 23:09
It soundsl like this is what you want. Please edit your question. Make us understand what is `Parent` , `UnderlyingType`? Show some code maybe. What you are saying is a bit abstract. At least to me. – panoskarajohn Dec 15 '19 at 09:15

Documenting members of members in C# XML-Comments

0 Answers0