-
Notifications
You must be signed in to change notification settings - Fork 448
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
Remove recommendation for ABAP Formatter #343
base: main
Are you sure you want to change the base?
Conversation
A: use of the pretty printer can be enforced, https://docs.abapopenchecks.org/checks/06/ |
> why we do not give clear guidance for the type case of keywords. | ||
> | ||
> Read more in _Chapter 5: Formatting: Team Rules_ of [Robert C. Martin's _Clean Code_]. | ||
Always use the [ABAPCleaner](https://github.com/SAP/abap-cleaner), ideally with the default configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should be the same as before: Always use your team's formatter settings. 😉
when name lengths etc. change; if you want to avoid this, consider dropping rules like | ||
[Align assignments to the same object, but not to different ones](#align-assignments-to-the-same-object-but-not-to-different-ones). | ||
|
||
Some of them might not be covered by automated code formatting tools, such as ABAP Formatter or ABAPCleaner, so manual effort to reformat statements might be necessary, but we recommend sticking with automated formatting as dar a s possible for the sake of consistency. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of them might not be covered by automated code formatting tools, such as ABAP Formatter or ABAPCleaner, so manual effort to reformat statements might be necessary, but we recommend sticking with automated formatting as dar a s possible for the sake of consistency. | |
Some of them might not be covered by automated code formatting tools, such as ABAP Formatter or ABAP Cleaner, so manual effort to reformat statements might be necessary, but we recommend sticking with automated formatting as much as possible for the sake of consistency. |
I generally support recommending the use of the ABAP Cleaner, but I think some more guidance and nuance is required.
|
is it clean to dig into exactly how and which tooling to use? eg. it currently doesn't recommend to use ATC/Code Inspector, does SAP recommend using exceptions or not, and how to, use central ATC or not? should developers use SE24 or Eclipse or vscode or notepad to write clean code? It opens for an endless list of questions on the exact tooling. I've yet to understand what exactly SAP means by Clean Code, but is it tooling dependent? I'd suggest to change the section to "Use common tooling inside the team", and then link to the tools sections for options and then each tool has to explain/recommend exactly how to use it. |
It seems that using a team-wide ABAP cleaner profile and sharing it would be a more effective option. |
Until now, the guide recommends the usage of the ABAP Formatter. From my perspective, the ABAPCleaner is superior and is getting more and more features, so the guide should recommend this.
What do you think about this?