Запитання з тегом «javadocs»

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

18 java  documentation  refactoring  javadocs 

Чи є хороший термін, схожий, але відмінний від "застарілого", щоб означати, що метод або API є в кодовій базі, але його не слід використовувати, оскільки його реалізація не завершена або, ймовірно, зміниться? (Так, я знаю, ці методи не повинні бути загальнодоступними, яда яда яда. Я не створив свою ситуацію, я …

12 documentation  terminology  api  documentation-generation  javadocs 

У JavaDoc для X509Certificate getSubjectDN()нього зазначено: Денігровано , замінено на getSubjectX500Principal (). Я звик бачити застаріле в методах для методів, які більше не слід використовувати, але не денігрувати. Я знайшов повідомлення про помилку щодо цього конкретного випадку, коли його було закрито коментарем: Це не помилка. "Зневищений" призначений для вживання лише …

11 java  terminology  javadocs 

Я працюю над невеликою бібліотекою, яка забезпечує реалізацію основних, добре відомих рядкових показників. Переважно для моєї власної освіти. Тож розвиток відбувається коли-небудь у мене трохи вільного часу. Через це я автоматизував більшість процесів, тому я можу випускати версію так часто, як я працюю над нею без особливих зусиль. Однак підтримка …

9 java  documentation  javadocs 

Я хочу написати Javadoc сухим способом. Але в документі Oracle про Javadoc сказано написати те саме, що в коментарі методу перевантаження Не можу я уникнути повторення?

9 documentation  comments  dry  javadocs