В колледже когда изучали Java заставляли хорошо документировать, и генерировать спомощью JavaDOC документацию, но я уже много что позабывал. Допустим есть два класса Animal и Dog.
1. Создадим папку src:
2. Запишим туда 2 файла:
Animal.java:

Код:
public class Animal {
}

Dog.java:

Код:
public class Dog extends Animal {
  private String nickname;
  private char gender;
  private int age;

  /**
   * <p>Конструктор</p>
   * @param nickname кличка
   * @param gender пол
   * @param age возраст
   * @since 1.0
   */
   public Dog(String nickname, char gender, int age) {
     this.nickname = nickname;
     this.gender = gender;
     this.age = age;
   }

  /**
   * <p>Установить кличку</p>
   * @param nickname кличка
   * @see <a href="get_nickname()">get_nickname()</a>
   * @since 1.0
   */
  public void set_nickname(String nickname) {
	this.nickname = nickname;
  }
  
  /**
   * <p>Возвращает кличку</p>
   * @return String
   * @see <a href="#set_nickname()">set_nickname()</a>
   * @since 1.0
   */
  public String get_nickname() {
	return nickname;
  }  

  /**
   * <p>Установить пол</p>
   * @param gender пол
   * @see <a href="#get_gender()">get_gender()</a>
   * @since 1.0
   */
  public void set_gender(char gender) {
	this.gender = gender;
  }
  
  /**
   * <p>Возвращает пол</p>
   * @return char
   * @see <a href="#set_gender()">set_gender()</a>
   * @since 1.0
   */
  public char get_gender() {
	return gender;
  }  
  
  /**
   * <p>Установить возраст</p>
   * @param age возраст
   * @see <a href="#get_age()">get_age()</a>
   * @since 1.0
   */
  public void set_age(int age) {
	this.age = age;
  }
  
  /**
   * <p>Возвращает возраст</p>
   * @return int
   * @see <a href="#set_age()">set_age()</a>
   * @since 1.0
   */
  public int get_age() {
	return age;
  }

  /**
   * <p>Возвращает гав-гав</p>
   * @return String
   * @since 1.0
   */
  public String bark() {
	return "Гав-гав";
  }

  /**
   * <p>Возвращает кличку, пол, и возраст</p>
   * @return String
   * @since 1.0
   */
  public String toString() {
	return nickname + " " + gender + " " + age;
  }	  
}

3. Выйдем из папки src, и введём команду:javadoc -encoding utf-8 -d doc src\*
4. Теперь перейдём в папку doc, и нажмём дважды на index.html:
https://i.ibb.co/wKJ2jFT/javadoc-result-07-29-29-07-2021-min.jpg