Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
@author (reference page)
You can provide one @author tag, multiple @author tags, or no @author tags. In these days of the community process when development of new APIs is an open, joint effort, the JSR can be consider the author for new packages at the package level. For example, the new package java.nio has "@author JSR-51 Expert Group" at the package level. Then individual programmers can be assigned to @author at the class level. As this tag can only be applied at the overview, package and class level, the tag applies only to those who make significant contributions to the design or implementation, and so would not ordinarily include technical writers.
The @author tag is not critical, because it is not included when generating the API specification, and so it is seen only by those viewing the source code. (Version history can also be used for determining contributors for internal purposes.)
If someone felt strongly they need to add @author at the member level, they could do so by running javadoc using the new 1.4 -tag option:
If the author is unknown, use "unascribed" as the argument to @author. Also see order of multiple @author tags.
Guidelines
This chapter doesn't appear to contain any implementable rule. Proposal:
| Documentation Comments Rule |
Checkstyle Checks Used |
Sample files |
@author |
-- |
|
Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
@author (reference page)
You can provide one @author tag, multiple @author tags, or no @author tags. In these days of the community process when development of new APIs is an open, joint effort, the JSR can be consider the author for new packages at the package level. For example, the new package java.nio has "@author JSR-51 Expert Group" at the package level. Then individual programmers can be assigned to @author at the class level. As this tag can only be applied at the overview, package and class level, the tag applies only to those who make significant contributions to the design or implementation, and so would not ordinarily include technical writers.
The @author tag is not critical, because it is not included when generating the API specification, and so it is seen only by those viewing the source code. (Version history can also be used for determining contributors for internal purposes.)
If someone felt strongly they need to add @author at the member level, they could do so by running javadoc using the new 1.4 -tag option:
If the author is unknown, use "unascribed" as the argument to @author. Also see order of multiple @author tags.
Guidelines
This chapter doesn't appear to contain any implementable rule. Proposal:
@author