ABAP Doc for ABAP CDS Views or how to document CDS View inline?

[gregorw]

Hello SAP ABAP CDS Specialists,

is it possible to add inline documentation using /** */ as it is supported since March 2020 in the SAP Cloud Application Programming Model? When such a comment is added for an Entity i.e.:

/** 
Entity with documentation
*/
entity Books : managed {
  key ID : Integer;
}

it will end up in the following Annotation in the OData Service EDMX File:

<Annotation Term="Core.Description" String="Entity with documentation"/>

I think that would be helpful because CDS Views might be quite complex and by using the well known /** */ syntax also non ABAP tools might be used to create the documentation i.e. based on the abapGit repository containing the CDS Views.

Best regards
Gregor

[ThFiedler · Accepted solution]

Hi Gregor,

for the documentation of ABAP CDS we offer KTD as the preferred solution. In-line documentation compared to ABAP Doc is not planned as far as I know.

Regards,

Thomas.

[UweFetzer_se38 · Accepted solution]

Knowledge Transfer Document (for those who don't know the abbreviation ... yet ... like me)