SAP / styleguides

This repository provides SAP style guides for coding and coding-related topics.
Other
1.66k stars 444 forks source link

Are Clean ABAP Guidelines already covered by code inspector #166

Closed MarcelHesen closed 4 years ago

MarcelHesen commented 4 years ago

Hi all, First of all forgive me if this is the wrong place to post. I choose this as it is something I would like to hear the community's opinion about.

So here goes: In our company I would like to introduce the Clean ABAP guidelines. Additional to that it would be helpful to have the capability to check the code against these guidelines. Preferably we would do this using ATC/CI. I was thinking of writing some myself, but then again, we have an open source community... :-)

So does anyone know whether the guidelines are (partially?) covered by existing or custom code inspector classes? If so, where can they be found!

pokrakam commented 4 years ago

Good question! I don't believe there is a single ATC rule set specific to Clean Code. As I see it, coding standards are a very customer-individual decision, and I would imagine most customers will only be gradually implementing these guidelines in phases. Another problem is that many rules depend on semantics and will be hard to implement technically. How could one check Descend one level of abstraction without understanding the meaning?

That said, I like the idea of trying to create such a check. Aside from the SAP-Delivered ATC checks, there are also some very good tools out there that are also of use. I would imagine that with a well-defined ATC check variant, abapLint and abapOpenChecks, you could probably cover 60-80% of this guide. Waiting to see if anyone else has some input.

fabianlupa commented 4 years ago

https://github.com/SAP/code-pal-for-abap

MarcelHesen commented 4 years ago

Thx guys, for taking the trouble to answer. Very useful pointers to (partial) solutions, great starting point for me to continue the search!