topic The way we Code in Application Development and Automation Discussions

The way we Code

kiran_k8 — Tue, 25 Sep 2007 04:13:12 GMT

Hi FOlks,

I wanna improve my coding standards.Earlier I used to code the below said way

report ztest.

delcarations

selection screen

perform1

perform2

perform3

form1

form2

form3.

Now I am doing it like the below said way

report ztest.

include ztop.(this include will have all the kind of declarations)

selection screen

perform1

perform2

perform3

include zprocessdata(this include will have all the subroutines)

This was the very first appearance of the program will have only a few lines with inlucdes,selection screen.It just improves the aesthetic appearance of the code.

Please opine and let me know if there are any better ways.

Thanks,

K.Kiran

Message was edited by:

Kiran K

Re: The way we Code

Former Member — Tue, 25 Sep 2007 04:19:12 GMT

Hi,

This is the best way to code. In additon to this add the relevant comment ( single line or multiple ) lines so that you can understand the logic at a later point of time. But any ways this the very clean way of doing the code and also modularize of the code.

Thanks,

Samantak.

<b>Rewards points for useful answers.</b>

Re: The way we Code

varma_narayana — Tue, 25 Sep 2007 04:22:26 GMT

hi. Kiran...

Check this Program structure:

REPORT ZXXXX .

<<TYPES AND DATA DECLARATIONS >>

<<SELECTION SCREEN>>

<<EVENT BLOCKS>>.

START-OF-SELECTION.

PERFORM F_GET.

END-OF-SELECTION.

PERFORM F_DISPLAY.

<<FORM ROUTINES DEFINITION>>

FORM F_GET.

ENDFORM.

So your coding standards are good.

<b>reward if Helpful.</b>

Re: The way we Code

Former Member — Tue, 25 Sep 2007 04:22:29 GMT

This is a sample program structure i am adding here. You can also move all FORMS and data declaration in respective include for a better modularization.

************************************************************************

Program name: Program name - Program title

Description: Description of program

Date/Author: Date Written/Authors name

Table Updates: Listing of tables updated

Input Parameters: (For Includes/ Function Modules)

Output Parameters: (For Includes/Function Modules)

Return Codes:

Special Logic:

Includes:

************************************************************************

M O D I F I C A T I O N L O G

************************************************************************

Date Programmer Request # Description
------ -------------- ------------- ---------------------------*
dd/mm/yy xxxxxxxxxxxxxx nnnnn New Program

************************************************************************

REPORT YUPSTDS .

************************************************************************

T A B L E S

************************************************************************

TABLES:

************************************************************************

S E L E C T O P T I O N S

************************************************************************

SELECT-OPTIONS:

************************************************************************

P A R A M E T E R S

************************************************************************

PARAMETERS:

************************************************************************

D A T A

************************************************************************

DATA:

Accumulators **

Constants **
Switches **
Work fields **
Internal Tables **
Data structures / Strings **

************************************************************************

I N I T I A L I Z A T I O N

************************************************************************

INITIALIZATION.

************************************************************************

A T S E L E C T I O N S C R E E N

************************************************************************

AT SELECTION-SCREEN.

************************************************************************

T O P O F P A G E

************************************************************************

TOP-OF-PAGE.

************************************************************************

E N D O F P A G E

************************************************************************

END-OF-PAGE.

************************************************************************

S T A R T O F S E L E C T I O N

************************************************************************

START-OF-SELECTION.

************************************************************************

E N D O F S E L E C T I O N

************************************************************************

END-OF-SELECTION.

************************************************************************

F O R M S

ashish

Re: The way we Code

former_member189629 — Tue, 25 Sep 2007 04:32:26 GMT

Kiran,

U got really good suggestions from all the above. I just wanted to add that there is no need and use to have includes unless you are coding a module pool program. Instead, have all the events and write your forms too in the same pgm. (to avoid existance of another Z object).

Apart from those, I would suggest the below:

- Only one statement per line

- Indent the program for readability

- All literals that are displayed on a report must use Text Elements

- Comment ur code properly

Re: The way we Code

kiran_k8 — Tue, 25 Sep 2007 04:37:24 GMT

Karthik,

You have touched upon what exactly I am expecting.So,you mean to say better not to use ZINCLUDES as it will be considered as separate zobject and a transport request will get created.Let's see what SDN experts say.

K.Kiran.

Re: The way we Code

kiran_k8 — Tue, 25 Sep 2007 05:12:22 GMT

Hi Folks,

Looking forward to SDN experts replies.

Thanks,

K.Kiran.

Message was edited by:

Kiran K

Re: The way we Code

Former Member — Tue, 25 Sep 2007 10:55:47 GMT

Hi kiran,

Ur way of coding is good.

Also u can make use of it.

************************************************************************

Program name: Program name - Program title

Description: Description of program

Date/Author: Date Written/Authors name

Table Updates: Listing of tables updated

Input Parameters: (For Includes/ Function Modules)

Output Parameters: (For Includes/Function Modules)

Return Codes:

Special Logic:

Includes:

************************************************************************

M O D I F I C A T I O N L O G

************************************************************************

Date Programmer Request # Description
------ -------------- ------------- ---------------------------*
dd/mm/yy xxxxxxxxxxxxxx nnnnn New Program

************************************************************************

REPORT YUPSTDS .

************************************************************************

T A B L E S

************************************************************************

TABLES:

************************************************************************

S E L E C T O P T I O N S

************************************************************************

SELECT-OPTIONS:

************************************************************************

P A R A M E T E R S

************************************************************************

PARAMETERS:

************************************************************************

D A T A

************************************************************************

DATA:

Accumulators **
Constants **
Switches **
Work fields **
Internal Tables **
Data structures / Strings **

************************************************************************

I N I T I A L I Z A T I O N

************************************************************************

INITIALIZATION.

************************************************************************

A T S E L E C T I O N S C R E E N

************************************************************************

AT SELECTION-SCREEN.

************************************************************************

T O P O F P A G E

************************************************************************

TOP-OF-PAGE.

************************************************************************

E N D O F P A G E

************************************************************************

END-OF-PAGE.

************************************************************************

S T A R T O F S E L E C T I O N

************************************************************************

START-OF-SELECTION.

************************************************************************

E N D O F S E L E C T I O N

************************************************************************

END-OF-SELECTION.

************************************************************************

F O R M S

Please reward points if useful....

Re: The way we Code

kiran_k8 — Tue, 25 Sep 2007 11:02:05 GMT

Shori,

Documentation part is ok buddy,I was talking about the coding exactly.

K.Kiran.

Re: The way we Code

Former Member — Tue, 25 Sep 2007 11:38:25 GMT

Includes are a fine way of defining data and performs, but only if your code is too large which makes the program more understandable to look at, say, module pool programs, otherwise writing everything in a single report is fine. And if ur report is simple and you have used seperate includes for declaring data and performs, then it will take slightly more time than code in a single report( the time taken to call the includes into memory, note that this time is very less, milliseconds, but just seeing the technical part). After all we are Technical consultants aren't we?

By The Way, if ur are using includes, u need not worry about another Transport Request, you can give it in the same request of the report...

Reward points if useful, get back in case of query...

Cheers!!!

Re: The way we Code

kiran_k8 — Wed, 26 Sep 2007 03:27:23 GMT

Sat Shree Kaal,

Yeah we can use the same transport request for all the includes that are connected to a single program.Looking forward to more replies from SDN experts.Is Rich,Anji and co reading this thread?

Thanks,

K.Kiran.

Re: The way we Code

former_member189059 — Wed, 26 Sep 2007 03:45:51 GMT

Few more tips...

1. Use indentation by making use of the 'Pretty Printer'

2. make sure you follow your company's coding standards

this may include naming conventions for programs and well as variables / tables

3. put a header at the top of the program specifying who created it, when and for what purpose

4. whenever a change is made, mention it in the header as well as in the code

5. to make the code 4.6c and lower compliant, ensure that no line exceeds 72 characters

6. make 'blocks' in the selection screen, group them properly and give them proper titles