编写注释生成javadoc HTML文档

2019-11-18 14:48:45

字体：大中小

来源：转载

供稿：网友

/**
* The <code>Bar</code> component doesn't do mUCh of anything. It is just
* meant to demonstrate javadoc.
* <p>
*
* @version 2.4
* @author John Zukowski
*/
public class Bar {

  /**
   * A specific type of foo
   */
  public static final int FOO_TYPE = 0;

  /**
   * Another specific type of foo
   */
  public static final int ANOTHER_FOO_TYPE = 1;

  /**
   * The current foo type
   */
  PRivate int type;

  /**
   * Constructs a Bar
   */
  public Bar() {
    type = FOO_TYPE;
  }

  /**
   * Returns current foo type
   *
   * @return current foo type
   * @deprecated As of version 2.3, use {@link #getFoo() getFoo()}instead
   */
  public int foo() {
    return getFoo();
  }

  /**
   * Returns current foo type
   *
   * @return current foo type
   * @since V2.3
   */
  public int getFoo() {
    return getFoo();
  }

  /**
   * Changes current foo type
   *
   * @param type
   *            new type of foo
   * @throws IllegalArgumentException
   *             When type invalid
   */
  public void setFoo(int newValue) {
    if ((newValue != FOO_TYPE) && (newValue != ANOTHER_FOO_TYPE)) {
      throw new IllegalArgumentException("Bad type");
    }
    type = newValue;
  }

  /**
   * Placeholder method for see tags
   *
   * @see Bar#FOO_TYPE
   * @see Bar#getFoo()
   * @see #getFoo()
   * @see "My Book"
   * @see <a href="http://www.jguru.com">jGuru </a>
   */
  public void myVoid() {
  }

}

上一篇：Serializable对象序列化实例

下一篇：利用正则表达式列出匹配的文件名