Application Development Blog Posts
Learn and share on deeper, cross technology development topics such as integration and connectivity, automation, cloud extensibility, developing at scale, and security.
cancel
Showing results for 
Search instead for 
Did you mean: 
JerryWang
Employee
Employee


The ABAP Class Documentation Generator works equal to the well-known JavaDoc tool for documenting Java classes. It is available in software component BBPCRM (starting with CRM 7.0)

A good documentation will
1. make handover more smooth, ease the know-how transfer
2. help customers e.g. for BAdI implementation reference

How to use:

1. Make documentation on class level. You need to create a dummy private instance method with naming convention CLASS_DOCU.Then make all documentations before the first line of that method implementation code.

http://farm6.staticflickr.com/5516/11336530844_488dacc2b7_o.png

2. In the method implementation source code, just make comments the same as the well-known JavaDoc before the first line of method source code as below.

http://farm6.staticflickr.com/5494/11336530824_f6cf0159a9_o.png

3. After you finish all documentations, use tcode CLASS_DOCUGEN to generate documentation:

http://farm6.staticflickr.com/5528/11336569563_ef198d42af_o.png

http://farm6.staticflickr.com/5480/11336505366_0ab98162d4_o.png

4. in class builder, click button to view generated documentation:

http://farm4.staticflickr.com/3749/11336569513_40b609c5fc_o.png

http://farm6.staticflickr.com/5522/11336505236_7d5e989231_o.png

http://farm6.staticflickr.com/5476/11336530594_40b37a5b6b_o.png

4 Comments