Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to write "XML doc" for declaration with multiple variables?

Working on a fairly large C# project which is getting way to manny simmilar variables so lets say i have a piece like this

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

how do i document them like i do methods (see below)?

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

In the end what i whould like to do is to write something like

    /// <param name="TempAngle">some</param>
    /// <param name="AngleCountDown">something</param>
    /// <param name="SightAngleFromCopter">something else</param>
    double
        TempAngle = 1,
        AngleCountDown = HalfSight,
        SightAngleFromCopter = 0;
like image 399
Thomas Andreè Wang Avatar asked Sep 08 '26 03:09

Thomas Andreè Wang


1 Answers

You have to write for each variable like this

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

More over this will only work for class level variables and not for method level variables.

like image 147
Nikhil Agrawal Avatar answered Sep 09 '26 18:09

Nikhil Agrawal