@var, @param, @return meaning in php comment

[terryds]

I often see comments like

/*** The database class to store PDO objects** @var object*/

What does @var mean?

And, i often see @param, @return too... What do they mean?

 

I've ever seen strange comment like this one below. Can you tell me what it mean?

 

/*** $Id$*/

Edited August 6, 2013 by terryds

[Ingolme]

As far as I know, that's not PHP syntax and, since it's in a comment, it won't do anything at all. I think it's a convention for developers to know what's in the code.

[thescientist]

it's probably a take on javadoc notation

http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html

http://en.wikipedia.org/wiki/Javadoc

Edited August 6, 2013 by thescientist

[boen_robot]

@Ingolme, @thescientistHave you two really not heard of phpDocumentor or are you being sarcastic ?

[Ingolme]

No, I generally don't work with anything besides bare PHP.

[thescientist]

i haven't, but assumed it was, as I mentioned, a take on javadocs, which is exactly what phpdocs is.