Я запускаю Checkstyle для некоторого кода и ищу хороший пример, чтобы понять, как добавлять комментарии для определенных целей.
Например, Checkstyle говорит, что я должен добавить комментарии для констант / переменных класса,Но нигде в официальном документе Oracle host я не могу найти пример этого.
Я искал в разных местах, но не смог найти краткий пример ... 1 2 3 4 5
Я решил, что смогу получить исходный код для класса Java Calendar,это был бы хороший пример.Вы можете увидеть все виды констант в документах API этого класса.
См. здесь .
Как я могу:
1) Получить исходный код для Календаря?
2) Найдите пример того, как вы должны документировать код, подобный этому, в Javadoc (Checkstyle flags это нужно):
private static final int NO_OF_RECORDS = 10;