search

Cysharp / ConsoleAppFramework

Zero Dependency, Zero Overhead, Zero Reflection, Zero Allocation, AOT Safe CLI Framework powered by C# Source Generator.
MIT License
1.63k stars 94 forks source link

Please introduce Option-like attributes again. #147

Open En3Tho opened 1 month ago

En3Tho commented 1 month ago

I've just tried migrating from v4 to v5 and I must say that using xml docs for commands description is a total letdown for me. My apps are small, I don't want to litter the code with xml docs because they take so much visual space, they are clunky and commands now simply take 2x visual space which is sad. It is also easier to miss important things when changing something because now these things are split apart and xml doc is technically not a part of a code. It's harder to refactor and is totally up to ide support.

My main use case was to simply have an attribute for short name and description. Maybe you can just introduce different attributes if it makes your life easier like ShortName(...), Description(...), Index(...) etc

I thank you for the hard work you do and I've been using CAF for basically every command line app I made but I don't get why should I litter the code with useless docs simply to generate things.

neuecc commented 1 month ago

Thank you for using it. Personally, I thought the attributes were noisy, but there were also some drawbacks with the document comments, so I'm open to the idea of adding them. I'm not sure when, but I'd like to consider it.