Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[C#] C# stub classes should use description attributes from XML file #727

Closed
rca22 opened this issue Oct 4, 2019 · 1 comment
Closed

Comments

@rca22
Copy link

rca22 commented Oct 4, 2019

The description fields for messages should result in C# comments in the generated code.

e.g.
<sbe:message name="MyMessage" id="201" semanticType="V" description="This is my message type."> <field name="MarketDepth" id="264" type="uint8" description="0=Full Book, 1=Top of Book, n=Number of Levels."/> ...

should result in

/// <summary>
/// This is my message type
/// </summary>
public sealed partial class MyMessage
{
...
        /// <summary>
        /// 0=Full Book, 1=Top of Book, n=Number of Levels.
        /// </summary>
        public byte MarketDepth
        {
        ...
        }
}

This will aid in understanding the C# classes without having to refer back to the XML frequently.

@mjpt777
Copy link
Contributor

mjpt777 commented Oct 4, 2019

We would welcome a PR for this or accept sponsorship for the development.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants