SAP中的文档维护

在SAP编程中，我们有时需要维护一些文档信息，供用户查看，了解程序的用途或具体含义等。

这些文档是程序中必不可少的组成部分，SAP提供了便利的维护工具。

 

1，程序的文档

SE80中打开某程序的源代码进入编辑状态后，点击菜单Goto--Documentation，即可编辑程序的文档。

这样，当用户运行程序后，即可点击标准菜单Help--Application Help，查看到程序员维护好的程序文档。

如果程序员希望通过ABAP代码调出程序文档，则可通过函数DSYS_SHOW_FOR_F1HELP实现：

  CALL FUNCTION 'DSYS_SHOW_FOR_F1HELP'
    EXPORTING
      dokclass   = 'RE' "Report
      dokname    = sy-repid "Report name
      short_text = 'X'
    EXCEPTIONS
      OTHERS     = 1.

 

2，消息的长文本

当程序运行过程中，出现提示消息后，双击该消息即可看到详细的文本说明。

那么该如何维护消息的长文本呢？在消息的维护界面中，先进入编辑状态，去掉Self-explanat'y上的勾，点击Long Text，即可进入该message的长文本维护界面。

另外在长文本中可以用&NAME&来引用程序中的变量值。

 

3，SE61，文档维护程序

其实不管是程序的文档还是消息的长文本，或者是Function Module的文档等，都可以在SE61这里进行维护的。

维护程序文本则在Document Class选择RE，维护消息的文本则在此选择NA。如果维护的是普通文本，则选择TX即可。

对于普通的文本，也可以通过函数DSYS_SHOW_FOR_F1HELP调出其文档：

  CALL FUNCTION 'DSYS_SHOW_FOR_F1HELP'
    EXPORTING
      dokclass                 = 'TX'
      doklangu                 = sy-langu
      dokname                  = 'YTEST_NORMAL_TEXT'
      doktitle                 = 'Docu title'
    EXCEPTIONS
      OTHERS                   = 1.

 

4，SE63，翻译文档

奇怪的是，SE61中好像不能进行长文本的翻译，只好搬出SE63这个翻译大师了。

如果我们创建好了EN的长文本，现在需要对应的ZH的长文本，则最好以ZH登陆。

输入SE63，点击“翻译”--R/3企业--长文本（文档），选择<TX>。

在接下来的界面中，对象名称填写YTEST_NORMAL_TEXT，源语言选择EN，目标语言选择ZH，点击“编辑”按钮即可翻译了。

相信这里介绍的已经能满足大部分的需要了。另外在文档中，好像还可以插入图片，可惜没有用过，不知道有没有人有兴趣研究下并共享呢？