topic Re: regarding include in Application Development and Automation Discussions

regarding include

Former Member — Wed, 30 May 2007 11:39:42 GMT

for existing program

i have created the include for data declaration

i have copied the data declaration part into that include

so i have to write the description for that include into that include flower box

please tell me clearly

this is the formate

&----

*& Program No : *

*& Description : *

*& Program Name : 01 *

*& Author : *

*& Creation Date: *

*& Program Type : *

*& SAP Release : *

*& Description : *

*& *

*& Transport No : *

&----

Re: regarding include

oliver — Wed, 30 May 2007 11:44:33 GMT

Well Rajeshreddy, I don't know about any SAP/ABAP special documentation convention.

For me this is all about what works for me, what does the customer want or which specs are in your dev team. It's for you and the people that work after you, so make it a precise as necessary.

But what you already have looks fine.

Maybe I wouldn't put in the SAP version. Transport order for this program/include are also available from menu Utilities -> Versions -> Version Management

Regards,

Re: regarding include

Former Member — Wed, 30 May 2007 11:57:55 GMT

well this description is a comment.

ABAP ignores comments. So for the ABAP interpreter it makes no difference what you write there, or even if you write there anything or not.

Just think about following:

What informations would you like to have displayed there when having to edit or maintain a already built program.

Re: regarding include

Former Member — Wed, 30 May 2007 12:18:18 GMT

Hi Rajesh,

Your main program will have a flower box and include will have a separate flower box since it is a different program. you have to put details about the include in the include flower box. Mention 'Program type' as include and in 'Description' mention that the include holds data declaration for main program <program_name> .

Award points if found useful.

Regards

Indrajit.

Re: regarding include

Former Member — Wed, 30 May 2007 12:19:47 GMT

The Header info you have written is quite good.Also you can try the below Header if you want ,which is used by our company.

*----

Author : your name
company affiliation - project - sub project area
Date : mm/dd/yyyy
Title : program title
Country/Region:
TPR :
Description:
This program will...

*----

Program Change History *
Purpose: document history of code changes within changed program, module,

function, screen logic ...

Adding New History: add new changes to BOTTOM of list.

----

Date Change-Req Description of Change *

----

Hope it helps

mark if useful

Regards

Tushar