Пример использования Javadoc в Java: синтаксис и форматирование

/**
 * Вычисляет произведение двух положительных целых чисел.
 * Отличается высокой эффективностью, превышающей уровень энергии программиста после кофе. ☕
 *
 * @param x Первый множитель, отрицательные значения запрещены.
 * @param y Второй множитель, также должен быть неотрицательным.
 * @return Результат умножения x на y, готовый по мановению волшебной палочки.
 * @throws IllegalArgumentException если хотя бы один из аргументов отрицателен —
 *                                  негативные значений здесь приниматься не будут!
 */
public int multiply(int x, int y) {
    if (x < 0 || y < 0) {
        throw new IllegalArgumentException("Оба множителя должны быть неотрицательными. Избегаем негатива!");
    }
    return x * y;
}

/**
 * Потокобезопасный счетчик, готовый победить состояние гонки.
 */
public class ThreadSafeCounter {
    // Реализация...
}

/**
 * @deprecated Устарел начиная с версии 3.2. Вместо него используйте {@link NewFeature},
 *             он работает быстрее и лучше, не утащит при этом ваш обед.
 */
@Deprecated
public class OldFeature {
    // Реализация...
}

🌲 Дерево классов: КорзинаЭкзотическихФруктов

    /**
     * 🗺️ Введение: "Представляем вашему вниманию КорзинаЭкзотическихФруктов – свежайший коктейль ароматов, ведущий от востока до дуриана — самого пахучего фрукта."
     * 🍍 @param tropicalFruits – массив сочных и изысканных экзотических фруктов.
     * 🌟 @return Отсортированная корзина экзотических вкусовых ощущений.
     * 🚫 @throws FruitException если фрукт не свеж или не экзотический.
     */
    public Basket collectRarest(TropicalFruit[] tropicalFruits)

🌳 Путь: collectRarest()
    – Краткое описание: ✍️ "Сборник исключительно редких фруктов для истинных гурманов."
    – Параметры: 🍍 "Царство экзотики: дуриан, питайя и многое другое. Обычные бананы — пройдём мимо."
    – Возвращаемое значение: 🌟 "Избранные фрукты из самых отдалённых уголков тропиков в одной корзине."
    – Риски: 🚫 "Фальсификат здесь не пройдёт. Мы гарантируем только настоящие экзотические изыски."

/**
 * Переводит первую букву строки в верхний регистр.
 *
 * <pre>
 * StringUtils.capitalize(null)  = null
 * StringUtils.capitalize("")    = ""    // Пустота – тоже сигнал.
 * StringUtils.capitalize("cat") = "Cat" // "мяу" стало "МЯУ"!
 * StringUtils.capitalize("cAt") = "CAt"
 * </pre>
 *
 * @param str  исходная строка, может быть null
 * @return строка со строкой, начинающейся с заглавной буквы, или {@code null}, если исходная строка была null
 */
public static String capitalize(String str) {
    // Здесь код...
}