SAP ABAP类自动生成帮助文档

Social media 在SP0开发的时候,建了CL_SOC_UTIL和CL_CRM_SOC_SMC_UIU_UTIL 两个util class。

这两个class里面有的方法是通过method name一眼就能看出用途,有的method取的不是很好,需要结合source code才能明白用途。
某些方法的实现逻辑比较复杂
某些方法是为了解决某些特殊的issue而引入的。

Social media开发时,在method source code内部写了注释,对于method 本身的用途和输入输出参数定义没有写注释。

其实ABAP也能和JAVA一样,通过维护特定格式的注释,最后自动生成文档。

Class level的注释:

Method level的注释:

用tcode CLASS_DOCUGEN生成文档,点这个button查看文档:



如果文档写的好, developer B在修改developer A实现的method之前,不用所有的细节都跑去问developerA了,直接看文档理解。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值