mkropat / betterwin32errors Goto Github PK

Hi @mkropat

This little nuget package is very very useful. I'm creating a "batch" (console app) framework that makes it easier for our developers to write such apps and be sure of solid support for exceptions etc, the framework makes it easy for a developer to now return one of your error codes (ultimately returned from Main) returning error codes is very important for console apps that are started by a scheduler or SQL server where the return code is leveraged.

It would be great to add the 'Description' attribute to each enum entry, where the text is simply the same as the existing comments.

Of course there are over 6,000 entries so this could be done piece meal, with periodic pull requests that simply add these gradually to the set.

I'd be happy to start this if you think it's something you'd like to see, e.g.

//
// Summary:
//     The operation completed successfully.
ERROR_SUCCESS = 0,

becomes

//
// Summary:
//     The operation completed successfully.
[Description("The operation completed successfully.")]
ERROR_SUCCESS = 0,

We could then add a simple static class and method to get this text for any enum value (defaulting to just the enum name if there is not yet a Description attribute for it).

Doing this here on the root repo is ideal too because with so many entries having multiple developers doing this would make it quicker overall.

I did something very similar once - in C - and had the description text too, being able to report that text was very very useful.

PS: Its tempting too to define an alias enum for ERROR_SUCCESS named simply SUCCESS...