Providing Documentation for Developers 

Many Web Dynpro objects such as components, applications, views, context nodes, or methods can now be documented with support of the Web Dynpro tools in the Web Dynpro Perspective. There are two categories of documentation for the logical Web Dynpro units:

●      Quick Info

○       Short documentation with 256 characters at maximum. Using special characters or JavaDoc is not possible.

●      Technical Documentation

○       Allows providing long documentation versions

Consider that methods and event handlers only can have some technical documentation piece but no quick info.

The end user of a Web Dynpro application can not access documentation that was written within the Web Dynpro Perspective of the SAPNetWeaver Developer Studio. We recommend that you use English as master language when creating these two documentation types since the documentation texts are not assigned to the resource bundles for text translation.

Entering technical documentation or quick info

       1.      Select the object for which you want to provide some documentation either in the Web Dynpro Explorer or in one of the graphical tools.

       2.      Open the Properties view. Enter and edit the documentation directly in the respective text field of the Properties View, and/or open the text editor by clicking the Edit button.

       3.      Goto the Documentation view that offers a formatted display of the quick infos and technical documentations by choosing Window  → Show View → Other → Other → Documentation View. Select the object for which you want to display the documentation.

You can also select a JavaDoc comment in the Java Editor and show it with the Documentation View.

 

Regarding docu synchronization there is no difference between the technical documentation of a method or an event handler and the JavaDoc comment of its implementation. Both documentations are kept identical by the tool. When the user saves the implementation of a method, the tool extracts the JavaDoc comment of the method and saves it as technical documentation. Conversely, when saving the technical documentation of a method, the tool generates the respective JavaDoc comment into the implementation.