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的原创文章，请关注公众号"汪子熙":

如何给ABAP类自动生成帮助文档相关推荐

【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
WebAPI——自动生成帮助文档
Web Api 自动生成帮助文档新建Web Api项目之后,会在首页有API的导航菜单,点击即可看到API帮助文档,不过很遗憾,Description 是没有内容的. 怎么办呢? 第一步: 如果用V ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
java自动生成接口文档
java自动生成接口文档 maven依赖工具类展示效果首页接口页在平时的开发过程中必定要写接口文档作为程序员最烦的2件事 1.别人让你写接口文档 2.接手别人的项目没有接口文档由此可见 ...
SpringBoot自动生成接口文档
跟大家介绍一个自动生成接口文档的工具包,作者的理念是注释即文档,在写代码的时候写上注释,项目启动后就会生成接口文档,非常方便,省去了Swagger写注解的过程. 仓库地址:https://github ...
DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
Django DRF 自动生成接口文档
文章目录 1. 引子 2. 自动生成接口文档 3. 文档描述说明的定义位置 1. 引子前端请求的url由谁来写 url 主要有后台来写,写完给前端: 如果后台查询数据,需要借助查询条件才能查询前端需 ...
自动生成接口文档之JApiDocs教程
JApiDocs教程前言作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...

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

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

如何给ABAP类自动生成帮助文档相关推荐

最新文章

热门文章