How To Fix SABAP_DOC112 - Character '&1' must be escaped in ABAP Doc

SAP Error Message - Details

• Message type: E = Error

• Message class: SABAP_DOC - ABAP Doc messages

• Message number: 112

• Message text: Character '&1' must be escaped in ABAP Doc

What causes this issue?

ABAP Doc has some reserved characters for its syntax.
If you want to use these characters in your documentation you have to
escape these characters. The following table shows you all reserved
characters in ABAP Doc and how you can escape them:

The system issues an error message and will not allow you to continue with this transaction until the error is resolved.

Character ,,Escape text ,,Description
<(><<)> ,,<(>&<)>lt; ,,less-than
> ,,<(>&<)>gt; ,,greater-than
@,,&#64;,,at
|,,&#124;,,pipe
{,,&#123;,,curly bracket (open)
},,&#125;,,curly bracket (close)
You also have to escape miscellaneous non alphanumeric characters.

System Response

Syntax check returns a warning.

How to fix this error?

Escape the reserved character in your ABAP-Doc-documentation.

Procedure for System Administrators

Error message extract from SAP system. Copyright SAP SE.

Smart SAP Assistant

• What is the cause and solution for SAP error message SABAP_DOC112 - Character '&1' must be escaped in ABAP Doc ?

  The SAP error message SABAP_DOC112 indicates that there is a character in your ABAP documentation that needs to be escaped. Specifically, the character & (ampersand) is a special character in ABAP documentation and must be handled properly to avoid issues in the documentation rendering.
  Cause:
  The error occurs when you use the ampersand character (&) in your ABAP documentation comments or documentation strings without escaping it. In ABAP documentation, certain characters have special meanings, and the ampersand is one of them. It is often used for variable substitution or formatting, so if it appears in the text without being escaped, the ABAP compiler will raise this error.
  Solution:
  To resolve this error, you need to escape the ampersand character in your documentation. In ABAP, you can escape the ampersand by using a double ampersand (&&). 
  For example, if your documentation contains:
  " This is an example with an & character
  You should change it to:
  " This is an example with an && character
  Related Information:
  
  Documentation Comments: In ABAP, documentation comments are typically written using the """ syntax. It's important to ensure that any special characters are properly escaped to avoid compilation errors.
  Other Special Characters: Besides the ampersand, there are other characters that may also need to be escaped in ABAP documentation, such as the percent sign (%) and the backslash (\). Always refer to the ABAP documentation guidelines for a complete list of special characters and their escape sequences.
  Testing: After making the changes, recompile your ABAP program or class to ensure that the error is resolved.
  
  By following these steps, you should be able to eliminate the SABAP_DOC112 error and ensure that your ABAP documentation is correctly formatted.