topic Re: Documentation for redefined methods? in Application Development and Automation Discussions

Documentation for redefined methods?

Former Member — Thu, 18 Jun 2009 11:53:22 GMT

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

Re: Documentation for redefined methods?

Former Member — Sun, 21 Jun 2009 11:38:46 GMT

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

Re: Documentation for redefined methods?

Former Member — Mon, 22 Jun 2009 06:33:15 GMT

This message was moderated.

Re: Documentation for redefined methods?

naimesh_patel — Mon, 22 Jun 2009 13:53:42 GMT

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

Re: Documentation for redefined methods?

matt — Mon, 22 Jun 2009 14:31:20 GMT


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

Re: Documentation for redefined methods?

Former Member — Tue, 10 Nov 2009 12:56:54 GMT

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.