On 18 March 2013 09:58, Jörg Schaible <joerg.schai...@scalaris.com> wrote:
> sebb wrote:
>
>> On 18 March 2013 09:17, Jörg Schaible <joerg.schai...@scalaris.com> wrote:
>
> [snip]
>
>>> Actually, for my own projects I always add
>>>
>>> @since upcoming
>>>
>>> or
>>>
>>> @deprecated As of upcoming ...
>>>
>>> When I prepare a release I use a the regular expression "s/(since|As of)
>>> (\s+)upcoming/\1\2VERSION/" to set the proper VERSION.
>>
>> Like it, except I tend to use
>>
>> @deprecated since 1.2.3
>>
>> I chose TODO because I have that set up to create a task flag in
>> Eclipse (and it is something to do).
>> But the exact placeholder is not critical.
>
> Fine with me. The reason for my "As of placeholder ..." pattern is a
> consequence of javadoc, since it prepends automatically "Deprecated. "[1]
> and uses the text of the tag as sentence[2]. Therefore I add in the real
> world a line like:
>
> @deprecated As of TODO use @{link } instead.
>
> IMHO the text should give a direct hint to any developer who tries to
> "update" his code in a pro-active way to newer functionality.
Agreed; I already added that to the Wiki at
http://wiki.apache.org/commons/CodeStyle
Probably need to add a sample usage.
> Looking
> currently at the deprecated stuff of lang[2] it fails such an explanation
> for some deprecated methods.
Now that would be a useful checkstyle rule!
> - Jörg
>
> [1] http://commons.apache.org/proper/commons-
> lang/apidocs/org/apache/commons/lang3/StringUtils.html#chomp(java.lang.String,
> java.lang.String)
> [2] http://commons.apache.org/proper/commons-lang/apidocs/deprecated-
> list.html
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
