为 ValueTuple 中的命名元素添加 XML 文档

问题描述 投票:0回答:2

借助 C# 7 中的

ValueTuple
,现在可以编写返回或使用复合对象的方法和属性,而无需显式声明类型。然而,如果没有提供文档,这些命名元组可能会造成混淆。

由于记录库的主要且可能是最方便的方法是使用 XML 文档,因此有什么方法可以使用 XML 文档来提供命名元组中变量的描述吗?

我知道明显的解决方案是声明一个类型并相应地记录它。然而,考虑到由于某些“原因”而无法完成,是否可以将数据成员以 XML 形式记录在

ValueTuple
中?

注意: ValueTuple

出现之前,也有人提出过类似的问题。

c#-7.0 xml-documentation valuetuple
2个回答
11
投票
C# 没有特殊的语法来记录元组的命名元素,您必须使用普通的

<returns>

<param>
 元素,并用文字解释每个命名元素包含的内容。

尽管有

建议将此功能添加到语言中


0
投票
没有丰富的语法,所以我使用类似的东西:

/// <returns><see cref="Tuple{Result, bool}"/>: (result code, enabled flag)</returns>
    
© www.soinside.com 2019 - 2024. All rights reserved.