“摘要”与“查看”或“ inheritdoc”?

时间:2018-08-22 10:49:43

标签: xml-documentation wvvm

我通常会像这样在ViewModel类中注释字段:

    /// <summary>
    ///     <see cref="Name" />
    /// </summary>
    private string _name;

但我当时想更改为:

    /// <inheritdoc cref="Name"/>
    private string _name;

考虑到名称是在同一类中定义的:

    /// <summary>
    ///     First Name of the Person
    /// </summary>        
    public string Name
    {
        get => _name;
        set
        {
            _name = value;
            RaisePropertyChanged();
        }
    }

这是继承的不好用法吗?我喜欢它,因为它比带有see的摘要短,但也许不是继承文档不正确的上下文。

0 个答案:

没有答案