[
https://issues.apache.org/jira/browse/XALANJ-2672?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17739297#comment-17739297
]
Gary D. Gregory commented on XALANJ-2672:
-----------------------------------------
In general @author tags are discouraged Apache wide IIRC but I don't have a URL
for that. Over in the Commons project, we not only stopped using them, but I've
removed most of them. The tags are usually misleading because that's usually
never the only person who touched the file. You then get into games about what
the threshold for adding a name is, and that's a waste of time IMO.
Instead, authors get credit in the pom.xml, and in changed.xml for each action
element which are used to generate release notes. And that's a much better
reflection of who did what.
My suggestion is that we do the same in Xalan-J.
> Suggestion: avoid adding @author tag to javadoc, or document its use
> --------------------------------------------------------------------
>
> Key: XALANJ-2672
> URL: https://issues.apache.org/jira/browse/XALANJ-2672
> Project: XalanJ2
> Issue Type: Improvement
> Security Level: No security risk; visible to anyone(Ordinary problems in
> Xalan projects. Anybody can view the issue.)
> Reporter: Vladimir Sitnikov
> Assignee: Gary D. Gregory
> Priority: Major
>
> {{@author}} tags are problematic since:
> * They can become stale, and it is hard to tell when they should be removed
> * It is hard to tell when a new author tag should be added
> See other samples in
> https://stackoverflow.com/a/17271433,
> https://github.com/junit-team/junit5/issues/914#issuecomment-328078934
> ---
> It is unclear if every contributor should add {{@author}} tag or not.
> It is unclear if {{@author}} tag should be removed in case the file is
> significantly modified.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@xalan.apache.org
For additional commands, e-mail: dev-h...@xalan.apache.org
