What is the date format for the "since" annotation in javadoc?

Question

I've tried googling this but didn't find a complete answer to this question:

Can I set the date format for the @since annotation in javadoc? Or how do I see what format is set?

score 9 · Accepted Answer · edited May 23 '17 at 11:51

9

The @since tag 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.

/**
 * @author    Firstname Lastname <address @ example.com>
 * @version   1.6        (current version number of program)
 * @since     1.5        (the version of the package this class was first added to)
 */

For more information visit:

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

javadoc: @version and @since

edited May 23 '17 at 11:51

Community

1
1

answered Aug 01 '13 at 10:27

Ankur Lathi

7,636
5
37
49

thanks, i was confused since on the wiki, the example given was a date-like version of a package! – Don Aug 01 '13 at 11:48
Wikipedia is not a normative reference. Use the reference material provided. – user207421 Aug 01 '13 at 11:53

Shamim Ahmmed · Answer 2 · 2013-08-06T10:27:42.130

3

The tag @since is not used to specify date rather it is used to provide information about the last version information

/**    
* @since 1.7
*/

edited Aug 06 '13 at 10:27

answered Aug 01 '13 at 10:24

Shamim Ahmmed

8,265
6
25
36

score 2 · Answer 3 · answered Aug 01 '13 at 10:25

2

@since 1.1

since is followed by a number which indicates some sort of version ID. Any format would do but N.N format is preferred

answered Aug 01 '13 at 10:25

Lai

472
6
23

score 2 · Answer 4 · answered Aug 23 '20 at 20:32

2

I believe that the string for @since has no real syntax, I write mine as @since 2020.09.22 which appears to be either a version or a date.

answered Aug 23 '20 at 20:32

B. Stackhouse

477
5
15

score 1 · Answer 5 · answered Aug 01 '13 at 10:27

1

@since annotation is used to describe when the functionality first existed, it's version number.

answered Aug 01 '13 at 10:27

AllTooSir

48,828
16
130
164

score 1 · Answer 6 · answered Aug 01 '13 at 10:28

1

As I know @Since is use to indicate version which start some implementation.

@Since 1.0  // meaning is this method start from version 1.0

answered Aug 01 '13 at 10:28

Ruchira Gayan Ranaweera

34,993
17
75
115

What is the date format for the "since" annotation in javadoc?

6 Answers6