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

Short text in ABAP Doc Comments

franz_reitmayer2
Explorer
0 Likes
3,239

Hi Everybody,

Is there any change to create and change method parameter short texts from eclipse adt (7.4. SP8) or is that a feature we've to wait for?

Regards,

Franz

1 ACCEPTED SOLUTION
Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,026

Hi Franz,

we have established a new documentation concept for ABAP development objects in AS ABAP 7.40 called ABAP Doc. With ABAP Doc you now document your parameters directly in the source code.

A good introduction of the topic was given by in this document :

Michael describes the option in eclipse to migrate all existing short texts of your classes and interfaces to the ABAP Doc notation. Give it a try!

Regards,

Thomas.

Hi Everybody,

Is there any change to create and change method parameter short texts from eclipse adt (7.4. SP8) or is that a feature we've to wait for?

Regards,

Franz

16 REPLIES 16
Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,027

Hi Franz,

we have established a new documentation concept for ABAP development objects in AS ABAP 7.40 called ABAP Doc. With ABAP Doc you now document your parameters directly in the source code.

A good introduction of the topic was given by in this document :

Michael describes the option in eclipse to migrate all existing short texts of your classes and interfaces to the ABAP Doc notation. Give it a try!

Regards,

Thomas.

Read only

0 Likes
3,026

Hi Thomas,

Thanks. I know ABAP Doc, as you could probably see at the subject. And I want to use it. My question is whether it's possible to handle the "old" short descriptions maintained at SE* also with ABAP Doc Comments?

As we won't have a big bang migration of our development tools, I will need to maintain comments at two places if it's not possible to create and edit short texts from ABAP Doc Comments.

Is there a @ShortText: .... ?

BTW: The "Create ABAP Doc from Short Text" isn't working at my system also.

Regards,

Franz

PS: I worked with Java and Eclipse for more than 10 years, so promoting that kind of feature to me is preaching to the choir.

Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,026

Hi Franz,

yes, this synchronization of short descriptions and ABAP Doc comments will be available in future.

There will be a special tag in the ABAP Doc comment that classifies the short descriptions. Once you classified that you can maintain the short description in both places: ABAP Doc and SE... transactions.

In our lab version it is already working. Let's see when we can ship the feature.

By the way we will also support the possibility to export ABAP Docs for whole classes, interface or even packages to an offline file or zip-package. I'm sure you will like it 🙂

Regards,

Thomas. 

Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,026

Hi Franz,

looks like the option to generate ABAP Doc from the descriptions only works for englisch descriptions in 7.40 SP08.

Do you have german description texts?

Regards,

Thomas.

Read only

0 Likes
3,026

Hi Thomas,

Yes, we have. Original language is DE.

Thanks for your support!

Regards,

Franz

Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,026

Hi Franz,

and what is your expectation? Do you expect that the tool imports the descriptions in language german?

Regards,

Thomas.

Read only

0 Likes
3,026

Hi Thomas,

I would expect to import the original language, no matter whether it's DE or EN. I've never seen a system where developers have used another language as the origianl language for their comments.

Regards,

Franz

Read only

Former Member
0 Likes
3,026

Hi Thomas,

another option would be to use the language with which the user is logged in to Eclipse. But I guess most of us will use the original language of all other objects, so that also new objects are created with this language as original, anyway.

Have a nice day!

O.

Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,026

Hi Franz,

to solve the issue we created the SAP Note http://service.sap.com/sap/support/notes/2162466

After installing that note you can import short descriptions also in master language.

Regards.

Thomas.

Read only

0 Likes
3,026

Hi Thomas,

Thanks a lot! Unfortunately I won't be able to apply it until next week, but I'm really looking forward to test it.

Regards,

Franz

Read only

Former Member
0 Likes
3,026

Hi Thomas,

we have tried to import this SAP Note to our 7.40 System, but it states, that it is obsolete. I checked the CL_OO_CLIF_UTILITY class, but it for sure needs to be changed.

Any ideas, why it was marked as obsolete?

Thank you and have a nice day!

Ondrej

Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,026

Hi Ondrej,

you need at least SP level 08 in order to install the Note.

Sorry,

Regards,

Thomas.

Read only

0 Likes
3,026

Hi Thomas,

I just downloaded and installed the Note. I tested with a single Interface, and it works fine.

Thanks a lot for your support!

Regards,

Franz

Read only

0 Likes
3,026

Hi Thomas,

is there a chance to modify this in regard to import ABAP Doc to Eclipse in login language? Maybe first trying to import in login language and than in original language if the former fails?

I'm trying to implement some coding guidelines in my company and one of those would be: All comments/in-code documentary shall be in English.

And therefore I'd like to import the English texts and not the (original) German ones.

Thanks and Regards,

Mark

Read only

ThFiedler
Product and Topic Expert
Product and Topic Expert
0 Likes
3,026

Hi Mark,

I have to think about it whether there might be side effects when importing the texts in logon language .  But why don't you change the original language of these objetcs?

Regards,

Thomas.

Read only

0 Likes
3,026

Hi Thomas,

thanks for the reply.

This actually might be a solution. I'll have to discuss it with my colleagues, though.

Could there be problems when delivering to our (mainly German) customers? I'm not sure how the target systems will react on changed original languages of imported objects - especially in regards to displayed texts.

Regards,

Mark