Вопросы по теме 'documentation-generation'
Отображение отчетов в формате HTML на панели управления CruiseControl
Я недавно изучал конфигурацию CruiseControl (я полный CC noob), и пока я понимаю, что различные отчеты XML, созданные вашим процессом сборки (например, mbunit.xml, ncover.xml, fxcop.xml), могут отображаться в панель управления, добавив ссылку на XML...
2110 просмотров
schedule
27.06.2023
Отметка использования примера в документации по коду
Как лучше всего размещать примеры использования в документации по коду? Есть ли стандартный способ? С @usage или @notes? Поддерживают ли генераторы документов это?
Я знаю, что этот вопрос должен зависеть от генератора документации. Тем не...
1720 просмотров
schedule
30.03.2022
Как добавить документацию для моих функций в Netbeans PHP?
Я попробовал следующее,
/*
* addRelationship
*
* Adds a relationship between two entities using the given relation type.
*
* @param fromKey the original entity
* @param toKey the referring entity
* @param relationTypeDesc the type of...
31002 просмотров
schedule
27.02.2024
Можно ли включать примеры кода при использовании HeaderDoc или Doxygen?
Я пишу структуру Cocoa в Objective-C и хотел бы использовать автора документации для создания ссылки на API. Для .NET легко включить примеры, используя:
/// <example>
/// <code lang="c#">
/// Console.WriteLine("Hello, World!");
///...
904 просмотров
schedule
23.04.2024
Проект Netbeans Maven: выходная папка JavaDoc
Я пытаюсь изменить выходную папку JavaDoc проекта Maven, который я разрабатываю в Netbeans.
До сих пор мне удавалось изменить его, выбрав Свойства проекта > Действия , выбрав действия Generate JavaDoc и затем задав свойство destDir ....
969 просмотров
schedule
16.04.2022
Хороший способ создать документацию для моего API, поддерживаемого сервлетами?
Кто-нибудь знает хороший инструмент или стратегию для создания внешней документации для набора сервлетов Java? Я мог бы, конечно, использовать мой любимый редактор форматированного текста для создания независимого документа. Но вероятность того, что...
653 просмотров
schedule
25.09.2023
Какой формат документации комментариев лучше для JavaScript?
Есть ли какой-либо формат документации комментариев для JavaScript и процессор для этого формата, который генерирует документацию HTML?
В настоящее время я использую комментарии VSDoc xml для предоставления помощи IntelliSense во время разработки,...
2931 просмотров
schedule
25.09.2023
Документация по CXF REST API с использованием Swagger
Согласно руководству Swagger, swagger поддерживает только Джерси (см. https://github.com/wordnik/swagger-core/wiki/java-jax-rs )
Есть ли у кого-нибудь опыт работы с swagger с реализацией CXF JAX-RS ? Не могли бы вы поделиться своими...
5020 просмотров
schedule
18.10.2022
генерировать документацию по замку из песка для решения С#
У меня есть решение vs2012, в котором есть несколько проектов С#. Я хотел бы создать некоторую документацию, используя Sandcastle для всей библиотеки.
Я просматривал документацию Sandcastle и не понимаю, как я могу создать документацию для всего...
3164 просмотров
schedule
02.07.2022
Как использовать LuaDoc с LuaForWindows
Вопрос весь в заголовке: как использовать LuaDoc с LuaForWindows?
В моей установке Lua у меня есть luadoc_start.bat, но окна команд закрываются, как только они открываются. Оттуда я не знаю, что еще я могу сделать.
Любая помощь ? Спасибо
662 просмотров
schedule
07.01.2023
Создание хорошей веб-документации из .pdf или .tex
Я написал документацию для приложения в LaTex, и мне было интересно, как лучше отобразить ее на веб-странице. Я могу просто преобразовать его в HTML, но мне интересно, есть ли лучший способ со всеми красивыми стилями css, выполненными автоматически,...
104 просмотров
schedule
01.08.2022
Как применить новую строку при создании файла docx с помощью DOCX4J
По учебникам, которые я видел. Я научился добавлять текст при создании файла docx. но потом каждый раз, когда я добавляю строку текста. Я заметил, что между первой строкой текста и второй строкой текста всегда есть пробел. так же, как дважды...
10720 просмотров
schedule
03.09.2022
Как указать порядок сортировки в Roxygen2?
Использование документации roxygen2 с функцией document devtools автоматически создает поле Collate: в ОПИСАНИИ пакета, независимо от того, необходимо ли загружать файлы библиотеки пакетов в определенном порядке.
Я работаю над пакетом с кучей...
1829 просмотров
schedule
15.10.2023
Как поддерживать документацию на предметно-ориентированном языке на основе JSON?
Мы разрабатываем язык описания игр, похожий на RPG. Раньше мы использовали уродливый низкоуровневый XML, но теперь мы переключились на высокоуровневый, почти удобочитаемый JSON (пока мы не выкатываем новый графический редактор и больше не нужно...
545 просмотров
schedule
02.09.2023
Документация по Python и JavaScript/AngularJS на одном сервере?
К преимуществам такого подхода относятся:
Единый синтаксис docstring везде
Централизованный сервер документации; найти все свои документы в одном месте
Поиск и переход к исходному коду из любой документированной функции или класса; на...
631 просмотров
schedule
13.10.2022
Создавать документы без зависимости от программ Office?
Есть ли способ для моего приложения создать документ, который нужно будет сохранить и распечатать, без использования какого-либо внешнего программного обеспечения? В настоящее время у меня есть электронная таблица, которая выполняет кучу вычислений,...
179 просмотров
schedule
29.01.2023
Есть ли в Android стандарт документации для настраиваемых атрибутов стиля XML?
Я могу документировать практически все, что есть в моих проектах Android, и создавать для них красивые ссылки на API.
Единственным исключением из этого правила являются файлы XML и особенно файлы атрибутов, которые содержат стилизуемые атрибуты....
2294 просмотров
schedule
15.09.2022
Документация Haxe XML: как исключить стандартную библиотеку?
Я хочу сделать небольшой инструмент в Haxe, который проверяет комментарии haxedoc. Я решил, что лучший способ получить эти комментарии — использовать опцию «haxe -xml» и загрузить полученный XML-файл.
Однако, когда я генерирую XML, кажется, что...
368 просмотров
schedule
15.02.2024
Замените doc на unidoc в publish-local
У меня есть проект sbt в многопроектной структуре. Поэтому я хочу использовать unidoc для создания документации. Но публикационное локальное использование всегда doc. Как заменить doc на unidoc. Я использую sbt 0.12.4.
Я нашел это Отключить...
95 просмотров
schedule
29.11.2023
Аргумент против опций в Typescript
На основе этого вопроса множество аргументов и объект параметров
Мне интересно, как это относится к Typescript. Я хотел бы принять решение, чтобы:
Подсказки, данные прекомпилятором/линтом, будут максимально актуальными.
сгенерированная...
2297 просмотров
schedule
22.11.2022
