topic Re: Description for Methods in Application Development and Automation Discussions

Description for Methods

hartmut_rapp — Thu, 05 Feb 2015 12:27:11 GMT

Hello,

Is there a posibility to put a description for method in eclipse as in SE80 (see Screen)?

regards

Hartmut

Re: Description for Methods

Former Member — Thu, 05 Feb 2015 13:12:12 GMT

Hi Hartmut,

does this document answer your question?
http://scn.sap.com/docs/DOC-40872

Regards, Felix

Re: Description for Methods

Former Member — Fri, 06 Feb 2015 10:45:01 GMT

Hi Hartmut,

You can give description to method in Eclipse as well. For that you have to make use of ABAP Doc comments. ABAP Doc comments are a special comments which you can add before any declarative statements.Information which you entered as an ABAP Doc comment for particular element will be shown in its code element information pop up. To see this information you can put a cursor on that element and press F2.

ABAP Doc comments are added in the source code one row above the element,in its definition area.ABAP doc comment starts with "!. If the comment is multi-line then every line of comment will start with "!.

Eg.

"! Method to calculate addition

"! @parameter lv_a 1st input number

"! @parameter lv_b 2nd input number|

METHODS:

calculate_add IMPORTING lv_a TYPE n

lv_connid TYPE n.

You can to generate ABAP Doc by importing the existing descriptions.To import the description in your class or interface, just open the class or interface and use the menu entry "Source > Import ABAP Doc from Descriptions".

Note: ABAP Doc has been introduced with SAP netweaver server ABAP 7.4 SP2.

Re: Description for Methods

hartmut_rapp — Fri, 20 Feb 2015 08:46:46 GMT

Thanks Sheha,

I think ABAP Doc is a cool feature. But in my case it does not solve the problem

Also the system is on 740 SP07, the import function for descriptions does nothing and vice versa if I make some ABAP Doc comments I can’t see them in SE24.

Or do I misunderstand anything?

Regards, Hartmut

Re: Description for Methods

hartmut_rapp — Fri, 20 Feb 2015 08:48:17 GMT

Hi Felix,

thanks, this is a great Doc but does not really solve my problem (see reply to Sheha below)

Regards, Hartmut

Re: Description for Methods

amol_samte — Fri, 20 Feb 2015 11:02:03 GMT

Very Intresting question Hartmut....

Well I am also looking for it....

Cheers,

Amol

Re: Description for Methods

Former Member — Mon, 23 Feb 2015 08:49:53 GMT

Hi Hartmut,

you can't see the descriptions in SE24, but if you press F2 in the Eclipse, you will see very nice description of the method. This will also be shown, if you have short descriptions in SE24.

Hope that helps...

Re: Description for Methods

ThFiedler — Mon, 23 Feb 2015 08:55:17 GMT

Hi Hartmut,

the import function from short-descriptions to ABAP Doc should work. Please open a OSS ticket for the issue so that our support can have a look on it.

Concering the other way around I have goods news for you. We are working on a synchronization between ABAP Doc on the short-descriptions. That means you can change both in the SE24 form editor and in the ABAP Doc as well and the editor takes care for synchronization. Feature will be available with the next major release.

Regards,

Thomas.

Re: Description for Methods

christianpunz — Mon, 06 Jul 2015 18:50:27 GMT

hi Thomas,

here I can say: Yippiyeah!!

thanks for all the progress in ADT/AIE (hm, I'm missing the memory inspector though)

chris

Re: Description for Methods

Former Member — Tue, 07 Jul 2015 04:31:06 GMT

But that would be available only for 7.4 and onwards, right?