topic Re: ABAP Doc for Method implementation in Application Development and Automation Discussions

ABAP Doc for Method implementation

koitka — Thu, 28 Nov 2019 09:29:13 GMT

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

Re: ABAP Doc for Method implementation

ascm — Thu, 28 Nov 2019 10:43:04 GMT

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.

Re: ABAP Doc for Method implementation

koitka — Mon, 02 Dec 2019 09:51:35 GMT

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.

Re: ABAP Doc for Method implementation

rajad — Mon, 02 Dec 2019 13:52:41 GMT

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.

Re: ABAP Doc for Method implementation

koitka — Wed, 04 Dec 2019 10:15:54 GMT

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...