what does " @param" mean?

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
bhonan
Forum Newbie
Posts: 14
Joined: Sat Feb 02, 2008 12:55 pm

what does " @param" mean?

Post by bhonan »

I'm new to php and am looking at some examples. I understand most of it, but am looking for the place to configure my login info. there's a lot of commented out lines with things like "@param $email" is there where I edit?
User avatar
onion2k
Jedi Mod
Posts: 5263
Joined: Tue Dec 21, 2004 5:03 pm
Location: usrlab.com

Re: what does " @param" mean?

Post by onion2k »

It's a phpdoc comment. It's used by phpdoc to generate documentation. It's not what you should be editing... if you don't use phpdoc you can treat it like it's just a comment.
Post Reply