Ensuring Program documentation with ABAP editor capabilities
As per the ABAP programming standard of clients, we have to always maintain header text, Insert , Replace, Comment and Delete comment lines for future reference. If the program inline documentation is not maintained, it will always be an issue reported during code review process.
If we could maintain code template, we can just use keyboard shortcuts to reuse the comment lines required as shown below. This approach has helped us implement coding standard in an easier way.
First go to ABAP editor ( THis feature is availble in ECC6.0 )
then create Code Template as per our inline documentation standard.
Here we use a template for the text. This could be a text that is used for marking modifications or Definition and implementation of new program changes.
* Begin of Insertion <username> <Date of Change>
* End of Insertion <username><Date of Change>
In this way we could ensure that all developers in a team are using the same way for inline documentation
and documentation time can be considerably reduced.