asked on

Organize my code

Hello All,

My question is kind of weird. I would like to have information on how to organize my code in a Delphi project.

I've been progamming in delphi since 5 years and I always find my code very difficult to clarify. So, I would like to have hint and tricks on how I can organize functions, procedures, properties in my code so other programmers (even me) would have no problem debugging my app.

Is there a kind of work around that I could use to document my code ?

All the application I've ever wrote were not really complex (most of all were "oneshot" application). But now, I've been working on couple of big project and my boss ask me to document my code to help me (or an other programmer) support it in future.

Can anyone help me on that ??
Thanks in advance.
Oteau

God_Ares

Yep this is a big problem in the coding industry. Making code reusable. There are manny way's to structorize your code but in general you should name variableles with propper names, comment things to their function

Bad example

for i:=1 to 100 do ; //Loop 100 times.

If you have funciotns /procedures 0ver 27 lines you should consider cutting them down (refractoring)

button1
{
...
lots of code
x := x +1;
...
}

button2
{
...
lots of code
x:=x+2;
...

}

button3
{
...
lots of code
x:=x+3;
...
}

consider making a procedure

procedure do_things(i:integer);
{
...
lots of code
x:=x:1;
...

}

also do pre en post

procedure do_things(i:integer);
(* pre: i has to be greater than 1 (or i>1)
post: all cards for user 1 are deleted
*)
{
...
lots of code
x:=x:1;
...

}

remember these are just examples...!!!

Diagrams are most helpfull..

look in to these and find out what you like best..

- state diagrams
- uml
- psd
- dfd (dfd level > 3)

there are some others...

also putting classes in diffrent units helps..

TMyClass1 in unit myclass1

these are just some examples...

don't worry to throw away code to rewrite it. (This is hard i know)

God_Ares

the use of a repository is verry recomended.!

beno

You could code more like Borland suggests: http://www.econos.de/delphi/cs.html

Here is a page with some links on how to write readable and understandable code:
http://delphi.about.com/cs/standards/index.htm

DelForEx is a very nice freeware tool to format your existing source code to match Borland standards.

oteau

ASKER

Hi beno,

Where can I find DelForEx ???

This could really help me.
Thanks
Oteau

God_Ares

http://www.dow.wau.nl/aew/downloads/DelForEx.zip

for delphi6

martin_g

A good book that has helped me is:
"Code Complete - A Handbook of Software Construction" by Steve McConnell - Microsoft Press. Very easy to follow and even uses Pascal/Delphi examples!

robert_marquardt

I would not start by using DelForEx. The tool itself is excellent, but you should better learn to write your code cleanly formatted.
The problem is your state of mind and a coding tool is only of limited use.
You should read the Borland coding standard and try to understand why it chooses the specific style convention.

oteau

ASKER

You are right robert. DelForEx is wonderfull to realign all the code, change uppercase and lowercase on reserved words. My first problem is how can I organize the logicial sequence of my code. Example :

In a form, I have 10 procedures, 5 functions, and a lot of code for button, menus, etc. Is it better for me to create an other unit to store my procedure and functions and to keep the code about the form in his own unit ? How can I separate the code for the form. I have 10 OnClick event for menu, 5 buttons and code assign for event on the form. Is there a "magical" way to organize all this to preserve a logical sequence for me and other programmer when we try to modify something ?

Thanks again for your help
Oteau

ASKER CERTIFIED SOLUTION

robert_marquardt

membership

This solution is only available to members.

To access this solution, you must be a member of Experts Exchange.

Start Free Trial

martin_g

I think you maky have answered your own question regarding separating code from form events (i.e OnClick). Separating functions from the form events will make more re-usable.
As to how to organize the functions, there are several ways depending on your needs. The simplest would be to group your functions alphabetically in the declaration section. Be sure to use the same grouping in the implementation. Comment your code profusely; explain what each procedure does and when/who last modified it and why. There are several helps for code organization out there. I like GE Experts.

oteau

ASKER

Thank you all for your help.

It will be very usefull for me and other programmer.

Thank you very much.
Oteau