15
ответов
Вы используете Javadoc для каждого метода, который Вы пишете? [закрытый]
Я должен писать Комментарии Документа для всех моих методов Java?
вопрос задан: 17 October 2008 04:16
13
ответов
Как управлять материалом программирования @todo? [закрытый]
Много лет мой код был полон этого вида комментариев://TODO: Добавьте....../* *TODO: Зафиксируйте... * */Теперь, я думаю для создания моего собственного @todo javadoc аннотация..., но прежде, чем сделать это я хочу...
вопрос задан: 21 July 2015 02:39
12
ответов
Простой Getter / Setter комментарии
Какое соглашение вы используете, чтобы комментировать геттеры и сеттеры? Это то, что я удивляюсь в течение достаточно долгого времени, например: / ** * (1a), что вы здесь положили? * @парам зарплата (1б), что вы положили ...
вопрос задан: 24 August 2013 01:55
11
ответов
Написание JavaDoc для метода [duplicate]
Я пишу следующий метод в java, который возвращает все нечетные числа меньше n. Я должен написать JavaDoc для этого метода. Я немного новичок в написании JavaDoc. Является ли следующий JavaDoc для этого ...
вопрос задан: 3 April 2015 10:16
10
ответов
Есть ли некоторые хорошие и современные альтернативы Javadoc? [закрытый]
Давайте столкнемся с ним: Вы не должны быть разработчиком, чтобы видеть, что Javadoc по умолчанию выглядит ужасным. Существуют некоторые ресурсы в сети, которые предлагают модернизированный Javadoc. Но поведение по умолчанию представляет...
вопрос задан: 28 June 2009 21:20
9
ответов
хороший пример Javadoc [закрывается]
существует ли хороший пример исходного файла, содержащего Javadoc? Я могу найти много хороших примеров Javadoc в Интернете, я был бы точно так же, как для обнаружения конкретного синтаксиса раньше создавало их, и...
вопрос задан: 3 April 2015 10:16
9
ответов
Тесты JUnit должны быть javadocced?
У меня есть много тестовых сценариев JUnit, которые в настоящее время не документируются с комментариями Javadoc. Остальная часть моего кода документируется, но я задаюсь вопросом, стоит ли это даже усилия зарегистрировать эти тесты....
вопрос задан: 26 November 2009 16:08
8
ответов
Действительно ли необходимо генерировать javadoc как часть процесса сборки? [закрытый]
Действительно ли необходимо генерировать javadoc как часть процесса сборки?
вопрос задан: 14 May 2014 19:51
8
ответов
Инструмент, чтобы добавить и завершить [закрытую] документацию исходного кода PHP
У меня есть несколько законченных, более старых проектов PHP с большим количеством из, включает это, я хотел бы зарегистрировать в стиле javadoc/phpDocumentor. Работая через каждый файл вручную и будучи вынужденным сделать...
вопрос задан: 14 January 2011 23:57
7
ответов
Как вы читаете JavaDoc? [закрыто]
Какие инструменты / сайты вы используете для чтения JavaDocs? В настоящее время я использую Firefox с 20+ открытыми вкладками при работе над проектом J2EE, чтобы иметь всю доступную документацию, которая не очень удобна, кушает ...
вопрос задан: 11 December 2015 09:42
6
ответов
Комментарии Javadoc должны быть добавлены к реализации?
Это - корректная практика, чтобы добавить комментарии Javadoc в интерфейсе и добавить некомментарии Javadoc в реализации? Большинство IDE генерирует некомментарии Javadoc для реализаций, когда Вы автоматический генерируете...
вопрос задан: 5 November 2017 22:21
6
ответов
Присоедините исходные файлы банки к Eclipse для управляемых Знатоками зависимостей
Я использую Знатока (и Знатока Интеграция Eclipse) для управления зависимостями для моих проектов Java в Eclipse. Автоматической функцией загрузки файлов JAR из репозиториев Знатока является реальное время...
вопрос задан: 3 May 2015 02:39
6
ответов
Eclipse: методы списка и переменные всех [закрытых] классов
Я начинаю использовать некоторый код Java, который был написан кем-то еще. Я должен понять, изменить и протестировать его. Автор не доступен теперь. Пакет имеет приблизительно 50 файлов (и так классы)...
вопрос задан: 14 April 2009 23:39
6
ответов
Документация кода для Дельфи, подобного javadoc или c# xml документ
Мне нужен инструмент документации кода, подобный javadoc или c# xml документ для кода Дельфи. Каков лучший инструмент? Я предпочитаю технологию, которая находится в будущем, совместимом с проектом замка из песка Microsoft.
вопрос задан: 25 October 2008 07:24
5
ответов
Как я могу генерировать комментарии Javadoc в Eclipse? [дубликат]
Возможный Дубликат: генератор шаблона Javadoc Является там способом генерировать комментарии Javadoc в Eclipse? Если так, что это?
вопрос задан: 23 May 2017 01:33
5
ответов
Как я исключаю определенный метод/конструктора из результатов javadoc задачи Ant?
Я использую javadocs, сгенерированный javadoc задачей Ant для документирования веб-сервиса, и я хочу исключить некоторых конструкторов из вывода. Как я делаю это?
вопрос задан: 13 July 2009 16:13
5
ответов
То, как автоматически генерировать комментарии для метода считывания/метода set на основе поля, комментирует в Eclipse?
Я хочу, чтобы Eclipse автоматически генерировал комментарии Javadoc для моих методов получателя и методов установщика на основе ранее определенных комментариев для полей. Как я могу достигнуть этого? Фон: политика в нашем...
вопрос задан: 16 June 2009 05:05
5
ответов
Как заключить в кавычки “* /” в JavaDocs
У меня есть потребность включать */в мой комментарий Javadoc. Проблема состоит в том, что это - также та же последовательность для закрытия комментария. Что надлежащий способ заключить этому в кавычки/выйти? Пример: / ** * Возвращает true если...
вопрос задан: 10 March 2009 19:15
5
ответов
Пример многострочного кода в комментарии Javadoc
У меня есть небольшой пример кода, который я хочу включить в комментарий Javadoc для метода. / ** * - например: просмотр списка объектов карты - * < code > * for (int i = 0; i < list.size (); i ++) {...
вопрос задан: 12 February 2009 15:59
5
ответов
Документация Заголовочного файла C/C++ [закрывается]
То, что Вы думаете, является лучшей практикой при создании общедоступных заголовочных файлов в C++? Заголовочные файлы должны содержать не, краткая или крупная документация? Я видел все почти ни из какой документации (надежда...
вопрос задан: 28 January 2009 10:15
4
ответа
Javadoc вставка диаграмм UML
Существует ли способ встроить изображения в мой JavaDoc? В основном я хочу включать некоторые диаграммы UML, объясняющие иерархию моих классов в части документации.Спасибо!
вопрос задан: 8 February 2017 08:55
4
ответа
Как я могу использовать “<” и “>” в javadoc без форматирования?
Если я пишу <xmlElement> в javadoc, это не появляется, потому что теги имеют специальные функции при форматировании текстов. Как я могу показать этому символы в javadoc?
вопрос задан: 1 January 2017 10:15
4
ответа
Генератор шаблона Javadoc [закрывается]
У меня есть большая кодовая база без Javadoc, и я хочу запустить программу для записи скелета с основной информацией о Javadoc (например, поскольку параметр каждого метода пишет @param...), таким образом, я просто должен заполниться...
вопрос задан: 6 January 2016 14:05
4
ответа
Повторно использовать Javadoc внутри Javadoc? [Дубликат]
Я только что узнал, и теперь я пытаюсь реализовать javadocs. Есть ли способ повторно использовать javadoc, который вы уже написали, например, когда вы перегружаете метод, чтобы принимать больше параметров? ...
вопрос задан: 14 February 2015 21:01
4
ответа
codestyle; помещенный javadoc прежде или после аннотации?
Я знаю, что это не является самым жизненно важным из проблем, но я просто понял, что могу поместить блок комментария Javadoc прежде или после аннотации. Что мы хотели бы принять как стандарт кодирования? / ** *...
вопрос задан: 5 December 2013 20:20
4
ответа
Как заниматься результатами поиска при поиске javadoc
Недавно я наблюдал много людей, все еще дающих ссылки на javadocs 1.4.2. Это - не совсем хорошая практика, и я хотел бы поднять вопрос. Это происходит потому что поисковые системы (Google в...
вопрос задан: 22 February 2010 14:45
4
ответа
Аннотация для отключения JavaDocs
Существует ли аннотация, чтобы объявить, что определенный метод не будет включен в JavaDocs даже при том, что это общедоступно? Что-то как: общественность @nojavadocs освобождает нечто () {//...} P.S. Я понимаю...
вопрос задан: 19 December 2009 15:59
4
ответа
Онлайн существует ли центральный javadoc репозиторий?
Я нашел некоторый пример кода, который использует интерфейс, названный com.sun.jersey.spi.container. ContainerRequestFilter. Кто-то был достаточно хорош отправить javadoc здесь, но просто похоже, что это были некоторые...
вопрос задан: 13 November 2009 15:49
4
ответа
Банка от HTML
Сторонняя библиотека, которую я использую, обеспечила JavaDoc HTML и связала файлы мусорного ведра в zip-файле. Как я могу создать файл банки из JavaDoc HTML?Спасибо.
вопрос задан: 3 June 2009 15:44
4
ответа
Как я могу отключить предупреждения (всей кодовой базы) во время javadoc компиляции?
Я застреваю с кодовой базой Java прежней версии, которая имеет тысячи предупреждений, когда Вы компилируете ее. Я хотел бы на самом деле зафиксировать источник всех этих предупреждений, но к сожалению это не опция в этом...
вопрос задан: 6 March 2009 22:05