Что такое теги @param и @return в IntelliJ IDEA?

Question

Я только начал использовать IntelliJ IDEA для программирования на Java и вижу теги (они называются тегами?), Такие как @param и @return. Какое значение имеют эти теги? IntelliJ на самом деле жалуется, если у меня нет этих тегов в моем коде!

Что наиболее важно знать и для чего они используются?

Я не смог найти ничего подходящего в документации IntelliJ относительно этих тегов.

Answer 1

Да, они называются тегами. Если вы видите эти теги в комментариях, они должны задокументировать параметры вашего метода и возвращаемое значение.

Они могут автоматически обрабатываться для создания документации JavaDoc. Сгенерированная документация будет аналогична Документация API Java . См. , как написать комментарии к документу для инструмента JavaDoc .