External Definitions

PHP programming forum. Ask questions or help people concerning PHP code. Don't understand a function? Need help implementing a class? Don't understand a class? Here is where to ask. Remember to do your homework!

Moderator: General Moderators

Post Reply
Shendemiar
Forum Contributor
Posts: 404
Joined: Thu Jan 08, 2004 8:28 am

External Definitions

Post by Shendemiar »

Code: Select all

/**
* @return
* @param _file filename including path to zip file
* @desc constructor, initialises class variables
*/
function ZipExtract($_file)
{ ....
What is the name for those definitions prior to the function/class so i could google for them... or if anyone could point me directly to some resource about them.
mabus
Forum Newbie
Posts: 17
Joined: Wed Apr 16, 2008 11:52 pm

Re: External Definitions

Post by mabus »

Shendemiar wrote:

Code: Select all

/**
* @return
* @param _file filename including path to zip file
* @desc constructor, initialises class variables
*/
function ZipExtract($_file)
{ ....
What is the name for those definitions prior to the function/class so i could google for them... or if anyone could point me directly to some resource about them.
Those are just comments, but a well structured, and well documented one. I do not know what those are called, but I follow and use that style.

You should try looking into "Phpdocumentor". Its a freeware, and you'll find what you're looking for there. It has a definition on what those are.
User avatar
John Cartwright
Site Admin
Posts: 11470
Joined: Tue Dec 23, 2003 2:10 am
Location: Toronto
Contact:

Re: External Definitions

Post by John Cartwright »

Moved to PHP-Code.
mabus
Forum Newbie
Posts: 17
Joined: Wed Apr 16, 2008 11:52 pm

Re: External Definitions

Post by mabus »

if you're code just to see something, like a code to output the contents of an array, then just let it be a code. But if you're developing an application, then it is a good time to dicipline yourself with OOP.
Post Reply