Подскажите пожалуйста, что означает "WARNING: Missing a Javadoc comment" при анализе кода.
Игорь
19 уровень
WARNING: Missing a Javadoc comment.
Обсуждается
Комментарии (3)
- популярные
- новые
- старые
Для того, чтобы оставить комментарий Вы должны авторизоваться
Ярослав Java Developer Master
25 марта 2019, 08:04
Странное предупреждение. Писать жавадоки - огромные затраты времени и силы, особенно, когда ресурсов и так немного. А самое ужасное - поддерживать их после. Чтобы внести любые изменения в логику класса, нужно изменить жавадоки. А иногда можно вовсе забыть изменить жавадоки, и тогда документация будет предоставлять ложную информацию.
Жавадоки можно писать только на устойчивых классах/компонентах программы, которые уже написаны и видно, что вряд ли будут переписываться.
0
Игорь
25 марта 2019, 08:09
И как быть в таком случае? Игнорировать данные предупреждения по стилю?
0
hidden #598481
25 марта 2019, 08:00
Это предупреждение, что у тебя в классе нет комментария Javadoc
0