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: 
Read only

Documentation for redefined methods?

Former Member
0 Likes
625

I seem not to be able to create documentation for redefined methods. In se80, the method docs only open in read-ony mode and display the documentation from the superclass.

Because the whole point of redefinitionis to add functionality, which of course should be documented, I am very unhappy with this. What do you recommend to do?

-- Sebastian

5 REPLIES 5
Read only

Former Member
0 Likes
592

I'm surprised no one has views on this. Do you all leave your methods undocumented?

I have decided to put a comment for each redefined method in the class documentation of the subclass. Though unsatisfactory, that is the best I can think of.

-- Sebastian

Read only

0 Likes
592

Good Finding Sebastian.

More over to the class documentation, you may also put the documentation as the comment in the beginning of the Redefined method.

I would suggest you to raise it to OSS to let SAP know about the issue.

Regards,

Naimesh Patel

Read only

matt
Active Contributor
0 Likes
592

>

> I'm surprised no one has views on this. Do you all leave your methods undocumented?

> I have decided to put a comment for each redefined method in the class documentation of the subclass. Though unsatisfactory, that is the best I can think of.

>

> -- Sebastian

If I'm designing a generic class for use by other programmers, then I might use the documentation. Otherwise, I document in the method.

In my experience that's where most developers look first. There's so many undocumented methods (and other objects) in SAP, that the thought to check it is usually a last resort!

Read only

Former Member
0 Likes
592

This message was moderated.

Read only

Former Member
0 Likes
592

From the replies I gather that there no one has a satisfactory solution. I am now documenting the added functionality in the ABAP code, and add a caveat to the superclass's method documentation to check the coding for further info.

In my opinion this is a really bad situation.