Application Development and Automation Discussions
Join the discussions or start your own on all things application development, including tools and APIs, programming models, and keeping your skills sharp.
cancel
Showing results for 
Search instead for 
Did you mean: 

ABAP Doc for Method implementation

koitka
Explorer
0 Kudos
645

Hi all,

currently, it seems to me that ABAP Doc Documentation can only be created on the level of method definition.

But how does that apply to the concept of object orientation?

E.g. if the method is defined in an interface and there are multiple implementations. In this case it would make sense to create a method implementation documentation using ABAP Doc, but this is not possible, or is it?

Another problem is the documentation of redefined methods in inhertited classes, same as a above. ABAP Doc can only be created once for the original method definition.

Gruß,

Sebastian

4 REPLIES 4

ascm
Explorer
496

Write the ABAP-Doc comment in the interface-definition of the method.

e.g.

 "! Writing Hello
 methods write_hello.

Every implementation of this interface method should write "Hello" and that's the reason why there is no need of documentation for every implementation. How the method implementation is doing his job isn't important for the comment.

0 Kudos
496

This does not allow detailed documentation. E.g. 2 classes are implementing the interface method, how to describe the difference? How should the caller decide wich one to choose if both share the same documentation. I think this is a limitation.

rajad
Participant
496

Agree with your response to Andrea's answer.
I can think of using Alias in which you can give a meaningful name to your interface method.

0 Kudos
496

How does Alias help? It is not possible to add an ABAP Doc Documentation to an alias.

If it was possible, this could at least be a workaround...