Notating and commenting and formatting PHP script suggestions

[LRW]

OK, this is probably an odd, but esy question. =)

I taught myself PHP from a Julie Meloni book and newsgroup questions.
So, I don't think I've really learned the proper way of organizing and
formatting and commenting PHP scripts.

I had an opportunity to work with someone using ASP.Net, and MAN was
the formatting strict and clear and precise and complete! So, I've
tried to do something similar with my PHP:
Putting all functions together at the top, using:
/*############## ############### #######
## BLOCKS LIKE THIS TO HEAD SECTIONS
############### ############### #######*/

///////////////////////////////////////////////
// Sections like this for small sub sections

Tabbing IF and WHILEs and the like.

What are some other examples of proper notation and formatting that
one would probably learn in a programming class which I've never had
the benefit of? =)

Oh, and I learned from some Linux shell script tutorial to comment the
top of the file with something like:

// name_of_file.ph p -- This script solves world peace
// written: 2004-09-10 By: Me

Thanks for any suggestions or samples!
Liam

[Berislav Lopac]

On 15 Sep 2004 08:15:56 -0700, LRW wrote:

OK, this is probably an odd, but esy question. =)

I taught myself PHP from a Julie Meloni book and newsgroup questions.
So, I don't think I've really learned the proper way of organizing and
formatting and commenting PHP scripts.

I had an opportunity to work with someone using ASP.Net, and MAN was
the formatting strict and clear and precise and complete! So, I've
tried to do something similar with my PHP:
Putting all functions together at the top, using:
/*############## ############### #######
## BLOCKS LIKE THIS TO HEAD SECTIONS
############### ############### #######*/

///////////////////////////////////////////////
// Sections like this for small sub sections

Tabbing IF and WHILEs and the like.

What are some other examples of proper notation and formatting that
one would probably learn in a programming class which I've never had
the benefit of? =)

Oh, and I learned from some Linux shell script tutorial to comment the
top of the file with something like:

// name_of_file.ph p -- This script solves world peace
// written: 2004-09-10 By: Me

Thanks for any suggestions or samples!
Liam

I strongly suggest you to use the Javadoc-based comments, as many tools
such as PHPDocumentor recognize it. Even PHP5 recognize it by default.

Berislav