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

Please introduce Option-like attributes again. #147

Open
En3Tho opened this issue Sep 12, 2024 · 1 comment
Open

Please introduce Option-like attributes again. #147

En3Tho opened this issue Sep 12, 2024 · 1 comment

Comments

@En3Tho
Copy link

En3Tho commented Sep 12, 2024

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
Copy link
Member

neuecc commented Sep 13, 2024

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.

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

No branches or pull requests

2 participants