Recommend native ENUM over alternatives #293
Conversation
N2oB6n-SAP
requested review from
HrFlorianHoffmann,
KlausHaeuptleSAP and
a team
as code owners
sautermi0
added
the
Adjustment Of Rule
| DATA(severity_as_char) = CONV symsgty( /compatbl/message_severity=>info ). "yields 'I' | ||
| DATA(severity) = CONV /compatbl/message_severity=>type( 'X' ). "yields /compatbl/message_severity=>exit |
There was a problem hiding this comment.
The use of comments in these examples violates the rule "Put comments before the statement they relate to"
There was a problem hiding this comment.
While that's true and it has already been changed by a subsequent commit pushed to this PR I personally don't agree. Note that there is a discussion ongoing in #297.
|
|
||
| To integrate native enumerations with legacy code that uses constants the `BASE TYPE` addition is available: | ||
| ```ABAP | ||
| CLASS /compatbl/message_severity DEFINITION PUBLIC ABSTRACT FINAL. |
There was a problem hiding this comment.
Most of the styleguide works using the namespace /clean/ for its examples. Wouldn't it be better to continue using it here?
There was a problem hiding this comment.
My intention was to highlight that this is not the cleanest pattern, merely the cleanest you can get while still bridging the legacy gap. Hence /compatbl/. Whenever possible BASE TYPE should be left out.
There was a problem hiding this comment.
Makes sense to me!
There was a problem hiding this comment.
(Note that the code section in the preceding paragraph which does not contain BASE TYPE uses /clean/ for that reason.)
As mentioned in the comments before there were some syntax errors and clean code violations.
|
|
|
I've tried the suggested compatibility approach and it sounds good to me. About two years ago I tried to find a way to make ENUMs work for me, but I wasn't able to find one. I really wonder why that was... I can only assume I didn't know about the BASE TYPE keyword. |
|
One month has passed sine requesting for feedback, enough review votes (5+1), no veto, thus we merge the request |
This proposal recommends
ENUMover enumeration patterns.ENUMhas the obvious advantage of being native to the language with both syntax checks and type-safe compilation.In the main styleguide
ENUMis therefore recommended over constants interfaces. The enumeration subtopic has been adjusted as well to reflect that recommendation, yet present all object-oriented alternative patterns as before.