Menu
Some Java classes, as Object define in java docs @author as unascribed
* @author unascribed * @see java.lang.Class * @since JDK1.0 */ public class Object {
I found that it may be used when author is unknown
If the author is unknown, use "unascribed" as the argument to @author.
And found a JDK not-issue which use the term when no author is defined
many reflection classes unascribed
Many of the new APIs have no @author tag.
So unascribed is basically a Java equivalent to "John Doe"/"Jane Doe"?
783
Javadoc @author tag In Javadoc, there is a @author tag, which is supposed to indicate the original author of the file and possibly all contributors, who made significant changes to the file. public class MaxLengthValidator {...
The tag is not actually included in generated Javadoc. At least not by default - you need to explicitly specify -author parameter to include the information in the generated documentation. Therefore it is only visible to a person, who is viewing the source code.
I would say that for most purposes @author is unwanted noise. The user of your API shouldn't - and probably doesn't - care, or want to know, who wrote which parts. And, as you have already stated, SVN already holds this information in a much more authoritative way than the code can.
To create a JavaDoc you do not need to compile the Java file. We can generate JavaDoc documentation in two ways. The command-line tool allows us to run the command through it. This command can be executed on a command line and has the following syntax. In the above command, we assume that all the files and Java classes are in the src folder.
Of course, the most basic way not to specify the author of some class is not to specify the author, i.e. not to write an @author tag.
Defining something like "unascribed" for not documenting an author is already redundant and (to me) seems a bit weird.
113
answered Oct 03 '22 08:10
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
