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

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

18 java  documentation  refactoring  javadocs 

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

12 documentation  terminology  api  documentation-generation  javadocs 

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

11 java  terminology  javadocs 

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

9 java  documentation  javadocs 

Я хочу написать Javadoc в сухом виде. Но документ оракула о Javadoc говорит, что напишите то же самое снова в комментарии метода перегрузки. Могу ли я избежать повторения?

9 documentation  comments  dry  javadocs