************************************************************************
* Blog: Throw these comments overboard
* Author: Michael Keller
* Date: 2025/02/11
* Tags: CleanABAP
*************************************************************************
*[INS,MKE250210, BEGIN] Dear community, there are
*[DELETE, Ticket 08154711] not helpful comments and there are
*[INSERT, Ticket 08154711] less helpful comments and there are
helpful comments. The less helpful comments simply get in the way of the reader of source code when reading straight ahead and disrupt the flow of reading.
“”””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””””
Sometimes they also draw attention ” due to
because of its content in the completely wrong direction and many exhausting thoughts later you realize that you have wasted mental energy for no benefit. ” ToDO anyone
* ———————————————————————-*
” MKE, 11/02/2025, important to mention
There are some helpful tips on the Internet on how to do it better.
************** “[INS,MKE250210, END]
If reading the beginning of this blog made you stressed, exhausted or hungry (after exertion, hunger usually comes), then it has served its purpose completely (my apologies at this point for the dramatic introduction).
We all read source code every day that is exactly like this. Once, twice, sometimes hundreds of times in a single day. It releases an incredibly negative energy that in turn robs us of our energy.
That is why we should all work on our commenting style or, better yet, our programming style. The comments shown above are not actually comments either, they are a manual aid to structuring and organization.
We don’t need to make things unnecessarily complicated for ourselves, our colleagues and future generations who will read our source code. CleanABAP has a lot of good recommendations, not only about how to write comments.
From my own experience, I can say: The CleanABAP recommendations are worth their weight in gold. Thanks to everyone who put together these recommendations. You saved all the other ABAP developers a lot of work.
Enjoy experiencing it
Michael