ITPub博客

首页 > 应用开发 > IT综合 > 如何给ABAP类自动生成帮助文档

如何给ABAP类自动生成帮助文档

原创 IT综合 作者:i042416 时间:2020-02-26 08:43:26 0 删除 编辑

# Sent: Friday, May 3, 2013 3:22 PM

Subject: generate class document automatically

Hi colleagues,

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了,直接看文档理解。

不知道你们正式开发开始后这个用得上不。


来自 “ ITPUB博客 ” ,链接:http://blog.itpub.net/24475491/viewspace-2677219/,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论
SAP成都研究院开发专家,SAP社区导师,SAP中国技术大使。

注册时间:2018-01-20

  • 博文量
    1286
  • 访问量
    549970