Is there a reason to include both @version and @since as part of a class?
They seem to be mutually exclusive.
Also, what does %I% and %G% mean, and how to set/use them?
@version %I%, %G%
Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
The
@versiontag should be the current version of the release or file in question. The%I%,%G%syntax are macros that the source control software would replace with the current version of the file and the date when the file is checked out.The
@sincetag should be used to define which version you added the method, class, etc. This is your hint to other developers that they should only expect the method when they run against a particular version of the package. I would consider these uber-important parts of the documentation if you’re shipping your code as a library intended for someone else to use.