Hi community,
Do you know how many typos you have in the documentation of your ABAP custom code, e.g. in short descriptions of your global classes? Very often it looks like this in the SE24:
Do you see the issues? Not quite obvious here.
In Eclipse the situation is quite better. Documentation of source code is done via ABAP Doc (ABAP Doc), our nice little concept to document classes, methods, parameters and so on. Have you ever realized what happens when you have a typo in your ABAP Doc comment:
Great, the editor automatically checks the right spelling and displays the errors by underlying the incorrect words. Today I found out that there is much more support for writing correct documentation in the editor. Thanks to the eclipse community that gave us these features for free.
You already know the quick fix functionality in the editor that helps you to write correct ABAP code. But have you ever tried to press CTRl+1 in the ABAP Doc section. Here we go:
The editor offers you several options in the quick fix dialog to change the spelling or to take over not known words to the dictionary.
What do you think? Is this helpful to improve the quality of your documentation?
Kind Regards,
Thomas.
You want to learn more about ABAP Doc and ABAP development in Eclipse in general?
Please visit our DEV266 hands-on session at Teched Las Vegas, Bangalore or Barcelona.
See you there.
- SAP Managed Tags:
2 Comments
