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了，直接看文档理解。
不知道你们正式开发开始后这个用得上不。
要获取更多Jerry的原创文章，请关注公众号"汪子熙":