Вступление
Я слышал о Javadoc с тех пор, как впервые прикоснулся к Java, примерно 5 лет назад. Но я понял, что до сих пор не понимал, что такое Javadoc, пока не написал эту заметку. Сначала я подумал, что Javadoc – это документация Java, которую можно распечатать или экспортировать в формате PDF. Да, документация о программе. Автоматически генерируется. Что ж, я не ошибся на 100%. Но кое-что, что я пропустил, было то, как создать или оставить хороший Javadoc.
Обычно разработчик оставляет комментарий и кратко объясняет строку кода. Как и в Java, мы используем символ “//” или “/** */”, чтобы оставить комментарий. Ну, это не Javadoc, который я недавно нашел. Это выходит за рамки этого. ха-ха, извините за мою неопытность:)
Явадок
Когда мы вызываем метод из другого класса, появляется небольшое всплывающее окно, объясняющее, что это за метод. Эти маленькие всплывающие окна, которые они называют JAVADOC ~
Я действительно не понимал, пока не обнаружил, что появилось мое собственное краткое объяснение этого метода. И понял, что это правильный способ сгенерировать/написать комментарий, чтобы стать Javadoc.
Как написать хороший Javadoc
Написание документации очень важно. Объясните очень кратко о методе/классе или о чем-нибудь еще. Так что следующий программист, который прочтет ваш код, поймет, что вы пытаетесь написать.
Над методом начните с/**, чтобы открыть раздел комментариев к блоку. В этом разделе комментариев можно применить html-код и тег markdown. Так что сделай это красиво 😉
Всегда включайте @param , @return, @throws в Javadocs. Это важно при вызове этого метода, и я понятия не имею, как использовать этот метод.
Я узнал, что за @param должно следовать объяснение самого параметра. например: @param first Нумерация первого числа @param secndNumb второе число
что-то вроде того. дополните его существительным. для получения подробной информации о том, как написать хороший Javadoc, пожалуйста, обратитесь к ссылке ниже ~
Рекомендации
Оригинал: “https://dev.to/ninankara/day-1-javadoc-5d79”