Skip to content

C# 如何给 ValueTuple 返回值添加注释

Updated: at 08:22,Created: at 08:55

在 C# 7.0 可以在一个方法的返回,返回多个参数,通过 ValueTuple 的方法,但是和单个参数返回不同的是,如何对多个参数返回每个参数进行单独的注释?

如使用下面的代码,我尝试在一个方法返回两个不同的概念的值,在之前,如果通过 out 的返回,我可以单独给每个参数做注释

static (int s, int t) F(int x, int y)
{
return (x + y, x - y);
}

我找了很多博客,发现可以使用的方法是在返回值注释里面使用 para 分割多个参数

/// <returns>
/// <para>
/// 注释 s 参数
/// </para>
/// <para>
/// 注释 t 参数
/// </para>
/// </returns>
static (int s, int t) F(int x, int y)
{
return (x + y, x - y);
}

现在 Proposal: multiple returns tags and name attributes in doc comments for a tuple return value · Issue #145 · dotnet/csharplang 还在想如何给多个参数返回值添加文档注释

如果你有好想法,欢迎在这个帖子 回复


知识共享许可协议

原文链接: http://blog.lindexi.com/post/C-%E5%A6%82%E4%BD%95%E7%BB%99-ValueTuple-%E8%BF%94%E5%9B%9E%E5%80%BC%E6%B7%BB%E5%8A%A0%E6%B3%A8%E9%87%8A

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。 欢迎转载、使用、重新发布,但务必保留文章署名 林德熙 (包含链接: https://blog.lindexi.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请与我 联系