如何编写“ XML doc”以使用多个变量进行声明?

Tho*_*ian 3 c# documentation xml-documentation

在一个相当大的C#项目上工作,该项目已经可以使用简单的类似变量,所以可以说我有这样的作品

    double
        TempAngle = 1,
        AngleCountDown = HalfSight,
        SightAngleFromCopter = 0;
Run Code Online (Sandbox Code Playgroud)

如何像执行方法一样记录它们(见下文)?

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

最后,我想做的就是写点东西

    /// <param name="TempAngle">some</param>
    /// <param name="AngleCountDown">something</param>
    /// <param name="SightAngleFromCopter">something else</param>
    double
        TempAngle = 1,
        AngleCountDown = HalfSight,
        SightAngleFromCopter = 0;
Run Code Online (Sandbox Code Playgroud)

Nik*_*wal 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;
Run Code Online (Sandbox Code Playgroud)

更重要的是,这仅适用于类级变量,不适用于方法级变量。

  • @ThomasAndreèLian将变量堆积在一起的方式对我来说很难看。而且,C#约定还以小写字母开头的变量(局部变量和字段)。两者都只是一个品味问题。 (2认同)