如何給ABAP類自動生成幫助文檔

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了，直接看文檔了解。

不知道你們正式開發開始後這個用得上不。

本文來自雲栖社群合作夥伴“汪子熙”，了解相關資訊可以關注微信公衆号"汪子熙"。