Vladimir Sitnikov created XALANJ-2672:
-----------------------------------------
Summary: 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
{{@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: [email protected]
For additional commands, e-mail: [email protected]
