comment a structure

[Sharon]

Hi all

I have this structure ,

public struct struct_name{

public int len;

public bool tmp;

}

What is the right way to comment this structure?

Every way I try I get this warning:

Missing xml comment for publicly visible type or member ...

Thank you

Sharon

[Bruce Wood]

/// <summary>This is what struct_name is for...</summary>
public struct struct_name{
/// <summary>This is what 'len' means.</summary>
public int len;
/// <summary>This is what 'tmp' means.</summary>
public bool tmp;
}

[Jon Skeet [C# MVP]]

Sharon <Sh*******@hotmail.com> wrote:

Hi all

I have this structure ,

public struct struct_name{

public int len;

public bool tmp;

}

What is the right way to comment this structure?

Every way I try I get this warning:

Missing xml comment for publicly visible type or member ...

Put an XML comment before the struct itself and each of the members:
/// <summary>
/// ...
/// </summary>
public struct struct_name{

/// <summary>
/// ...
/// </summary>
public int len;

/// <summary>
/// ...
/// </summary>
public bool tmp;
}

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too