Question

我正在寻找一种在接口、抽象类和派生类之间自动匹配方法签名的方法。当我更改其中一个注释时，它真的很痛苦，手动更新它 3 次，因为我必须在接口、抽象类和派生类中更新它.. 是否有 VS 扩展或可以帮助我做到这一点的东西自动地？顺便说一句，我正在使用 ReSharper Ultimate。不确定它是否有这样的扩展名。

next_token

Answer 1

C# 中的文档注释允许您使用 <inheritdoc> 标记，以自动让派生类型重用层次结构中更高级别的文档注释：

public interface IBotClient
{
    /// <summary>
    /// Gets account balance for an asset.
    /// </summary>
    /// <param name="asset">The asset.</param>
    /// <param name="ct">Cancellation token.</param>
    /// <returns>The account balance.</returns>
    /// <exception cref="T:ElonMuskBot.Core.Exceptions.CallFailedException">If the call fails.</exception>
    Task<Balance> GetBalanceAsync(string asset, CancellationToken ct = default);

    /// <summary>
    /// Gets account balances.
    /// </summary>
    /// <param name="ct">Cancellation token.</param>
    /// <returns>The account balances.</returns>
    /// <exception cref="T:ElonMuskBot.Core.Exceptions.CallFailedException">If the call fails.</exception>
    Task<IList<Balance>> GetBalancesAsync(CancellationToken ct = default);

    ...
}

///<inheritdoc cref="IBotClient"/>
public abstract class BotClientBase : IBotClient
{
    
}

///<inheritdoc/>
public class SpotBotClient : BotClientBase
{
    
}

Answer 2

我发现 ReSharper 内置了它。

Alt+Enter 在覆盖方法上，然后“从基础复制文档”。

自动更新方法签名（例如摘要注释）

2 个答案: