Как писать хорошие комментарии javadoc? [closed]

В его нынешнем виде этот вопрос не подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, потребует дебатов, аргументов, опросов или расширенного обсуждения. Если вы чувствуете, что этот вопрос можно улучшить и, возможно, снова открыть, Посетите справочный центр , чтобы получить рекомендации.

Закрыт 6 лет назад .

Я разработчик Java и заинтересован в улучшении качества комментариев Javadoc в коде и программах, которые я пишу, чтобы сделать его более понятным и простым для реализации другими разработчиками.

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

java javadoc

задан Benjamin R 8 August 2014 в 06:21

0 ответов

Другие вопросы по тегам:

java javadoc

Как писать хорошие комментарии javadoc? [closed]

0 ответов

Похожие вопросы: