Create ABAPDoc Comments in Your Class in ABAP Environment
April 21, 2020
Beginner
10 min.
Learn how to maintain ABAPDoc documentation for your class in SAP Cloud Platform, ABAP Environment so your comments appear in the Outline view.
You will learn
- How to maintain ABAPDoc comments
- How to synchronize comments so they appear in the Outline View
- How to add an sorted list
- How to create a link to other development object documentation within ADT
Prerequisites
- You have an entitlement to SAP Cloud Platform, ABAP Environment. For more information, see Tutorial: Create Your First ABAP Console Application, steps 1-2
- You have installed ABAP Development Tools, latest version
- Tutorial: Create an AMDP and Analyze Its Performance
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
with your initials or group number.
Step 1: Open ABAP class
Step 2: Create ABAPDoc comment
Step 3: Add sorted list
Step 4: Add link
Step 5: Check comment
Step 6: Test yourself
More Information
- SAP Help Portal: Editing ABAP Doc Comments
- SAP Keyword Documentation: ABAPDoc