How to add c# xml cref comment for a complex expression?

Question

I would like to add a cref for the expression Bars[0].Name

Here is the code but it generates 2 warnings

using System.Collections.Generic;

namespace MyProject
{
    class IFoo
    {
        public Bars Bars { get; } = new Bars();

        /// <summary>
        /// Returns true if <see cref="Bars[0].Name"/>  is empty or null.
        /// </summary>
        /// <value>Indicates if name is empty or null</value>
        public bool IsFirstBarChildNameEmptyOrNull() =>
            Bars.Count == 0 || string.IsNullOrEmpty(Bars[0].Name);
    }

    class Bars
    {
        private List<Child> _children = new List<Child>();

        public Child this[int index] => _children[index];
        public int Count => _children.Count;
    }

    class Child
    {
        public string Name { get; set; }
    }
}

How can I add this cref without generating a warning?

I have found that if I add P: then the warning goes away. E.g. <see cref="P:Bars[0].Name"/> But I don't know if this is a good solution or not — RM.
– RM., Commented Mar 10, 2021 at 9:35

Matthew Watson · Accepted Answer · 2021-03-10 09:29:52Z

0

You can't do it directly like that.

You could get close by splitting it into two like so:

/// <summary>
/// Returns true if <see cref="Bars"/>[0].<see cref="Child.Name"/> is empty or null.
/// </summary>
/// <value>Indicates if name is empty or null</value>

answered Mar 10, 2021 at 9:29

Matthew Watson

111k12 gold badges179 silver badges301 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to add c# xml cref comment for a complex expression?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related