Formatting ABAP Doc Comments
You can format ABAP Doc comments with XHTML tags.
Context
This enables you to structure and highlight parts of your comments that are rendered, for example, into HTML files or the ABAP Element Info view.
You can use the following XHTML tags to format text:
| Formatting option | Tag | Alternative Tag |
|---|---|---|
| Line break | <br/> | <br></br> |
| Paragraph | <p>...</p> | |
| Emphasized text | <em>...</em> | |
| Strong emphasized text | <strong>...</strong> | |
| Unsorted lists | <ul><li>...</li></ul> | |
| Sorted lists | <ol><li>...</li></ol> | |
| Headers | <h1>...</h1> <h2>...</h2> <h3>...</h3> |
Note In addition, ABAP Development Tools (ADT) analyzes the content of
ABAP Doc comments, converting it to HTML, and displays it appropriately.
Consequently, special characters such as ", ', <, > and @
must be escaped using " , ' ,
< , > , and
@ .
Example
"Test class" will be formatted as cursive:
"! <em>Test class</em> for demo class CL_FOR_TEST_DEMO definition public final create public.