[ 
https://issues.apache.org/jira/browse/XALANJ-2672?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17739301#comment-17739301
 ] 

Mukul Gandhi commented on XALANJ-2672:
--------------------------------------

@Gary, if there's an ASF wide mandatory requirement not to have the @author 
tags within project codebase, I'll definitely adhere to that for XalanJ 
codebase that I'm currently involved with (please point to relevant ASF link, 
if there's any detail mentioning these points).

For now, on the XalanJ dev branch xalan-j_xslt3.0, the files which I began 
writing and wrote substantial code within that, I'd wish to retain the 
currently mentioned @author tags with my details mentioned within those files. 
If we could, have an ASF link that says, @author tags within project codebase 
is prohibited, I'll promptly remove my authorship references within the XalanJ 
codebase files to which I've contributed.

I also agree to your points, that largely correctly argue about ASF codebase 
not to have @author tags. I'd definitely be sensitive, about these aspects 
whenever I'll add or modify further code for XalanJ. Moreover, IMHO, any XalanJ 
committer may do any edits responsibly (including deleting any @author tags) 
within any of the currently available XalanJ codebase.

> 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

Reply via email to