Вопросы с тегом «javadocs»

18
Самодокументируемый код против Javadocs?

Недавно я работал над рефакторингом частей базы кода, с которыми я сейчас работаю, - не только для того, чтобы лучше понять это, но и для того, чтобы облегчить работу тех, кто работает над кодом. Я склонен полагать, что самодокументированный код - это хорошо . Я просто думаю, что это чище, и если...

12
Как документировать экспериментальные или неполные API, такие как @deprecated?

Есть ли хороший термин, который похож, но отличается от «не рекомендуется», чтобы означать, что метод или API находятся в базе кода, но не должны использоваться, потому что их реализация не завершена или, вероятно, изменится? (Да, я знаю, эти методы не должны быть общедоступными, яда, яда, яда. Я...

11
Устаревшие против Denigrated в JavaDoc?

В JavaDoc для X509Certificate getSubjectDN()этого говорится: Денегратировано , заменено getSubjectX500Principal (). Я привык видеть устаревшие методы for, которые больше не должны использоваться, но не Denigrated. Я нашел сообщение об ошибке в этом конкретном случае, когда оно было закрыто с...

9
Как поддерживать примеры кода в Javadocs в актуальном состоянии

Я работаю над небольшой библиотекой, которая обеспечивает реализацию основных, хорошо известных строковых метрик. Главным образом для моего собственного образования. Так что развитие происходит всякий раз, когда у меня есть немного свободного времени. Из-за этого я автоматизировал большинство...