3

处理一个相当大的 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;
4

2 回答 2

5

您必须像这样为每个变量编写

/// <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;

此外，这仅适用于类级别变量，不适用于方法级别变量。

于 2013-03-20T01:46:49.453 回答
0

语言规范告诉您 XML 注释应该出现在哪里以及它们适用于什么。

文档评论§19.1（强调我的）

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

在您的情况下，您正在记录这些字段的声明声明。如果该语句中恰好有多个变量声明，则您无法选择文档适用于哪些变量，这不是它的设计方式。

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

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

于 2019-05-09T16:53:51.357 回答