如何编写申报多变量“XML文档”？(How to write “XML doc” for decla

其上越来越方式曼尼simmilar变数相当大的C＃项目工作，所以可以说我有一块这样的

    double
        TempAngle = 1,
        AngleCountDown = HalfSight,
        SightAngleFromCopter = 0;

我如何记录他们喜欢我做的方法（见下文）？

    /// <summary>
    /// general explanation
    /// </summary>
    /// <param name="a">some hole num</param>
    /// <param name="b">some string</param>
    public MainWindow( int a ,string b)
    {} 

在我喜欢对子级做到底是喜欢写东西

    /// <param name="TempAngle">some</param>
    /// <param name="AngleCountDown">something</param>
    /// <param name="SightAngleFromCopter">something else</param>
    double
        TempAngle = 1,
        AngleCountDown = HalfSight,
        SightAngleFromCopter = 0;

Answer 1:

你必须写这样每个变量

/// <summary>
/// general explanation for TempAngle
/// </summary>    
double TempAngle = 1;

/// <summary>
/// general explanation for AngleCountDown 
/// </summary>
double AngleCountDown = HalfSight;

/// <summary>
/// general explanation for sightanglefromcopter
/// </summary>
double SightAngleFromCopter = 0;

更多在这样只会类级别的变量而不是方法级别的变量的工作。

Answer 2:

该语言规范告诉您XML注释应该出现并应用于什么。

文档注释§19.1 （重点煤矿）

具有特殊形式的注释可以被用于引导，以产生从这些评论和源代码元素，它们先于XML的工具。 这种评论是与三个斜杠（///），或分隔符的注释以斜杠开始和两个星（/ **）开始单行注释。 他们必须紧挨一个用户定义的类型（例如，类，委托或接口）或构件（如一个字段，事件，属性或方法）它们注释。 属性段（属性规范）被认为是声明的一部分，所以文档注释必须先施加到类型或成员的属性。

在你的情况，你记录这些字段的声明语句。 如果恰好是该声明中的多个变量声明，你不能挑选出你的文档适用于哪些变量，这只是不是，它是如何设计的工作。

为什么出现这样方法声明/定义的唯一原因是，参数是什么定义了方法，他们没有分开不同元素的一部分。

我跟你这是“丑陋和bloaty，”在一个声明，宣布多个变量的评估不同意是为了方便节省一些按键。 你需要做的任何这些变量的不同的东西（如采用不同的改性剂或简单地记录它们）的那一刻，他们必须分开。

文章来源: How to write “XML doc” for declaration with multiple variables?