Javadoc: @author tag

@author tag is used to specify the author of the module.

Syntax

@author author1, author2…author

You can specify multiple author names in one @author tag (or) you can use multiple author tags to specify multiple author names.

Arithmetic.java

package com.java.tags;

/**
 * 
 * @author Hari Krishna
 * @author Keerthi
 * 
 * @since Version 1.1
 *
 */
public interface Arithemtic {

 /**
  * 
  * @param a
  *            First Operand
  * @param b
  *            Second Operand
  * @return sum of two operands a and b
  * 
  * @since Version 1.1
  * 
  */
 int sum(int a, int b);
}

When you generate Javadoc for above interface, it looks like below.

As you above image, author names are part of Author section in the java documentation.

Previous                                                 Next                                                 Home