Question

处理一个相当大的C＃项目，这个项目正在变成manny simmilar变量，所以让我说我有这样的一块

    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

Language Specification告诉您XML注释应出现在何处以及它们适用于什么。

文档注释§19.1（重点是我）

具有特殊格式的注释可用于指导工具从这些注释和它们之前的源代码元素生成XML。此类注释是以三个斜杠（///）开头的单行注释，或者是以斜杠和两个星号（/ **）开头的带分隔符的注释。 它们必须紧随其注释的用户定义类型（例如，类，委托或接口）或成员（例如，字段，事件，属性或方法）之前。属性部分（属性说明）被视为声明的一部分，因此文档注释必须在应用于类型或成员的属性之前。

对于您而言，您正在记录这些字段的声明语句。如果在该语句中碰巧有多个变量声明，那么您就无法确定文档适用于哪些变量，而这并不是它的设计工作方式。

出现方法声明/定义的唯一原因是参数是定义该方法的一部分，它们不是单独的不同元素。

我不同意您对它的评估“丑陋且肿胀”，在一个语句中声明多个变量是节省某些击键的一种便利。当您需要对这些变量中的任何一个做不同的事情（例如应用不同的修饰符或简单地记录它们）时，必须将它们分开。

如何写＆＃34; XML doc＆＃34;用多个变量声明？

2 个答案: