Create ABAPDoc Comments in Your Class in ABAP Environment

First, open the ABAP class ZCL_AMDP_DEMO_XXX from the tutorial Create an AMDP and Analyze Its Performance

1. Immediately before the class definition, add an ABAPDoc comment to the class by entering "! and choosing Auto-complete ( Ctrl+Space ).

2. From the dropdown list, choose Paragraph, then add the following comment:

   "!<p>Class tests AMDP</p>

   

   You must insert the ABAPDoc comment immediately before the declaration; otherwise you will get a warning from ADT.

3. Add the following to the paragraph ( <p> ) tag: class="shorttext synchronized", so your code looks like this:

   Code Copy

   "!<p class="shorttext synchronized">Class tests AMDP: </p>

4. Add the following comments to the table type ty_result_line and to the method GET_FLIGHTS respectively:

   Code Copy

   "!<p class="shorttext synchronized">Table type of Flights from HANA DB</p>
   "! <p class="shorttext synchronized"> Method reads flights from HANA DB using AMDP</p>

5. Save and activate your class.

The comments should now appear in the Outline View:

1. Choose Enter. The system automatically inserts the ABAPDoc comments annotation "!" for you.

2. Again, choose Auto-complete ( Ctrl+Space ). Then choose Sorted list.

   

3. Add the following two statements, so that your code looks like this:

   Code Copy

   "! <ol>
   "!    <li>Reads flights from HANA DB</li>
   "!    <li>Converts currency to EUR</li>
   "! </ol>

1. Immediately after the sorted list, choose Enter.

2. Now enter the following comment:

   "! <p>Implements the interface { @link INTF: if_oo_adt_classrun } </p>

This creates a link to the Element information for that interface.

1. Save and activate your class ( Ctrl+S, Ctrl+F3 ).

2. Select your class and choose Show code element information (F2).

3. Your comments should appear look like this:

   

4. If you choose the link to the interface, its documentation appears:

   

• SAP Help Portal: Editing ABAP Doc Comments
• SAP Keyword Documentation: ABAPDoc