Page 1 of 1

External Definitions

Posted: Fri Apr 25, 2008 12:32 pm
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.

Re: External Definitions

Posted: Sat Apr 26, 2008 11:59 am
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.

Re: External Definitions

Posted: Sat Apr 26, 2008 12:23 pm
by John Cartwright
Moved to PHP-Code.

Re: External Definitions

Posted: Sat Apr 26, 2008 1:15 pm
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.