[
https://issues.apache.org/jira/browse/LANG-370?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12840586#action_12840586
]
Sebb commented on LANG-370:
---------------------------
That's good - it can easily be found and converted to annotations later if
necessary.
However, I would probably add the closing </p> tag, and allow comments:
{code}
* <p>#NotThreadSafe# - mutable static field defaultEncoding</p>
{code}
For non-Javadoc comments, one could use something like:
{code}
//#GuardedBy("this")#
private long counter;
{code}
> Document thread safety of classes
> ---------------------------------
>
> Key: LANG-370
> URL: https://issues.apache.org/jira/browse/LANG-370
> Project: Commons Lang
> Issue Type: Wish
> Components: General
> Reporter: Sebb
> Fix For: 3.0
>
>
> Few if any of the LANG classes state whether they are intended to be
> thread-safe or not.
> As a library, such documentation is essential IMO.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
