terryds Posted August 6, 2013 Share Posted August 6, 2013 (edited) 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 Link to comment Share on other sites More sharing options...
Ingolme Posted August 6, 2013 Share Posted August 6, 2013 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. Link to comment Share on other sites More sharing options...
thescientist Posted August 6, 2013 Share Posted August 6, 2013 (edited) 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 1 Link to comment Share on other sites More sharing options...
boen_robot Posted August 15, 2013 Share Posted August 15, 2013 @Ingolme, @thescientistHave you two really not heard of phpDocumentor or are you being sarcastic ? Link to comment Share on other sites More sharing options...
Ingolme Posted August 15, 2013 Share Posted August 15, 2013 No, I generally don't work with anything besides bare PHP. Link to comment Share on other sites More sharing options...
thescientist Posted August 16, 2013 Share Posted August 16, 2013 i haven't, but assumed it was, as I mentioned, a take on javadocs, which is exactly what phpdocs is. Link to comment Share on other sites More sharing options...
Recommended Posts
Create an account or sign in to comment
You need to be a member in order to leave a comment
Create an account
Sign up for a new account in our community. It's easy!
Register a new accountSign in
Already have an account? Sign in here.
Sign In Now