Kristian Waagan wrote:
Hello,
In a patch I worked on, I came across JavaDoc where the first line of
the method documentation was "JDBC 3.0". This looks a bit odd in the
generated JavaDoc, so I decided to replace it with a @since tag.
When reviewing the patch, Knut Anders raised the issue of which value to
use for the tag.
I used "1.4" - for Java 1.4, which was the release vehicle for JDBC 3.0.
Knut Anders suggests using a Derby version, for instance "Derby 10.4.2.0".
There seems to be several artifacts we could version against:
- Derby
- JDBC specification
- Java specification
It would be nice if the community could discuss the general usage of
@since tags, and also which values/versions to use with it.
Note that the tag value is "free form" - any text can be used.
Since the tag is free form and generally more information is better, I
would think that whichever specifications and/or versions that make
sense can be added, e.g.
@since Derby 10.4, JDBC 4.0
Dan.
