Home | About | Sematext search-lucene.com search-hadoop.com
 Search Hadoop and all its subprojects:

Switch to Plain View
Accumulo, mail # dev - Encourage the use of @since


Copy link to this message
-
Encourage the use of @since
Christopher 2013-01-17, 21:40
I would like to propose and encourage the use of the @since javadoc tag for
all new public/protected methods in the public API, as well as new classes
in the public API.

I would also like to propose and encourage the words "since <version>" be
used as the first two words of all @deprecated javadoc tags.

These are enormously useful for documenting to users when a new feature was
added/changed, as well as informing developers how long something has been
around, and thus informing decisions about when it is safe to remove or
change.

--
Christopher L Tubbs II
http://gravatar.com/ctubbsii
+
David Medinets 2013-01-17, 22:07
+
Eric Newton 2013-01-17, 22:48
+
Josh Elser 2013-01-18, 00:41
+
Jason Trost 2013-01-18, 12:30