Create ABAPDoc Comments in Your Class (On-Premise)
Learn how to maintain ABAPDoc documentation for your class so your comments appear in the Outline view.
You will learn
- How to make your program more readable by learning how to maintain
ABAPDoc
comments. - How to synchronize the documentation and to display it, both in the ABAP Development Tools (ADT) and in SAP GUI.
Prerequisites
- You have a valid instance of an on-premise AS ABAP server, version 7.51 or higher (some ABAP Development Tools may not be available in earlier versions)
- You have installed ABAP Development Tools, latest version
ABAPDoc comments are used to document your code. This makes it more readable. If other developers use one of your development objects, they can find out more about it by selecting the object name in the code and choosing Element Info ( F2
)
All ABAPDoc comments begin with "!
.
Always replace XXX
or 001
with your initials or group number.
More Information
- SAP Help Portal: Editing ABAP Doc Comments
- SAP Keyword Documentation: ABAPDoc