Описание тега documentation-generation
Генератор документации - это инструмент программирования, который генерирует документацию, предназначенную для программистов (документация по API) или конечных пользователей (Руководство для конечного пользователя), или для того и другого, из набора специально прокомментированных файлов исходного кода, а в некоторых случаях и двоичных файлов.
4
ответа
Как документировать код C в Eclipse (всплывающие подсказки типа intellisense/javadoc)
Можно ли документировать код C в Eclipse (3.4 с CDT) таким образом, чтобы документация, подобная JavaDoc/Intellisense, автоматически создавалась и отображалась? Например, при вводе имени функции, за которым следует '(', вы получаете первый параметр …
19 фев '09 в 20:33
2
ответа
Как сгенерировать документацию для других проектов в рамках решения с использованием DocFx
Я использую DocFx для автоматического создания документации в Visual Studio 2015. В соответствии с инструкциями по началу работы я добавил пустое веб-приложение ASP.NET 4 и использовал консоль Nuget для установки пакета сборки DocFx (например, Insta…
23 фев '16 в 22:02
1
ответ
Как создать документацию из документов XML?
Мне дали набор XML документы от компании, которая должна включать "документацию" XML схемы. Нет XSDs предоставлена. Как я могу генерировать документацию (например, HTML или же CHM) из этих XML-документов, которые включают документацию, указанную ниж…
30 янв '13 в 00:56
1
ответ
Как создать диаграмму отчетов в Enterprise Architect?
Я пытаюсь создать диаграмму отчетов с образцом документа и спецификацией отчета в Enterprise Architect. Смущает то, что я делал это раньше, но не могу понять, как я это сделал. И я не делал заметок, которые я, вероятно, должен делать, потому что для…
22 май '18 в 12:17
4
ответа
Как узнать, в каком модуле выполняется мой код?
Очень долго, когда у меня есть обработчик ошибок, я заставляю его сообщать, в какой проект, модуль и процедуру была добавлена ошибка. Я всегда выполнял это, просто сохраняя их имя через константы. Я знаю, что в классе вы получаете имя программным …
26 июн '09 в 18:35
1
ответ
Как документировать приватный (не публичный интерфейс) с помощью appleDoc?
Недавно я узнал, как использовать appleDoc для создания документации для моего проекта iphone. Но я понимаю, что AppleDoc сканирует только заголовочный файл каждого класса и на основе специального формата комментариев создает docSet и html. Мой вопр…
30 сен '13 в 01:38
0
ответов
Как преобразовать документацию консольного приложения Qt и описание его аргументов из основного кода C++ Qt во внешний формат
Предположим, что приложение Qt C++ использует QCommandLineParser для определения и обработки его аргументов и опций в соответствии с типичным шаблоном (упомянутым ниже). Есть ли способ преобразовать описание конкретных аргументов и параметров из исх…
20 авг '18 в 15:38
1
ответ
Как объединить документацию по разным языкам / средам?
Я проектирую библиотеку классов, предназначенную для решения широкого круга задач. Одна вещь об этой библиотеке - то, что она будет использоваться несколькими различными языками и средами изначально. Например, будет версия C++, полностью написанная …
19 июн '10 в 07:35
1
ответ
Добавление файлов в подпапках в документацию sphinx (sphinxcontrib-matlabdomain)
У меня есть каталог, содержащий различные папки, в каждой из которых есть исходные файлы Matlab. Некоторые из этих папок имеют подпапки, содержащие исходные файлы Matlab. Как создать дерево оглавления с помощью Sphinx для вложенных папок? Например, …
02 ноя '15 в 20:37
1
ответ
Преобразовать код + комментарий в системе контроля версий в читаемую документацию
Мы используем mercurial-hg и git и задаемся вопросом, есть ли способ создать документацию из существующего кода и только что проверенного кода. Есть ли какой-нибудь плагин, который мы можем подключить к mercurial-hg/git, который генерирует документа…
10 фев '10 в 15:20
0
ответов
Не генерируется никаких выходных данных для автоматического документирования с помощью sphinx на коде fortran
Мы хотим использовать инструмент Autodoc Sphinx для составления документации на фортрановые программы. Используя два расширения, разработанных vacumm "vacumm.sphinxext.fortran_domain" и "vacumm.sphinxext.fortran_autodoc", мы должны быть в состоянии …
15 янв '15 в 13:18
1
ответ
Пакеты отчетов в Enterprise Architect
В чем разница между стереотипом "главный документ" и "пакет отчетов" в Enterprise Architect? Я буду генерировать документ из нескольких типовых документов, и я хочу организовать их лучше, чтобы имитировать структуру результирующего документа. Я дума…
16 мар '17 в 18:04
0
ответов
Генерация raml из примера ответа JSON
Я только что узнал о RAML - языке моделирования RESTful API, и он кажется довольно полезным. У меня есть некоторые конечные точки, которые возвращают JSON. Существует ли какой-либо инструмент или код для генерации RAML из одного или нескольких приме…
07 ноя '14 в 18:57
0
ответов
Правильный рендеринг замен Sphinx в расширении httpdomain
Я использую расширение sphinxcontrib-httpdomain для написания документации по Sphinx. Это расширение может генерировать страницу " таблицы маршрутизации", которую я определил следующим образом. Я также определил замену, которую я использую в своих д…
09 июн '15 в 10:55
1
ответ
Документация Python и JavaScript/AngularJS на одном сервере?
Преимущества этого подхода включают в себя: Согласованный синтаксис документации везде Централизованный сервер документации; найти все свои документы в одном месте Поиск и переход к источнику из любой задокументированной функции или класса; на любом…
20 янв '14 в 07:49
2
ответа
Как использовать LuaDoc с LuaForWindows
Вопрос весь в названии: как использовать LuaDoc с LuaForWindows? В моей установке Lua у меня есть luadoc_start.bat, но окно команд закрывается, как только оно открывается. Оттуда я не знаю, что еще я могу сделать. Любая помощь? Спасибо
22 фев '13 в 21:45
0
ответов
Есть ли способ указать поддерживаемые методы отправки в Swagger Jaxrs Doclet?
У меня есть служба отдыха, мне нужно выставлять своих клиентов. Документация сделана Swagger-jaxrs-doclet. Это работает так, как я хочу, но я не хочу, чтобы мои клиенты отправляли запросы на мои услуги через API. Причина проста, я не хочу, чтобы они…
21 апр '15 в 12:03
1
ответ
Обновление комментариев vsdoc в JavaScript
Есть ли инструмент для обновления комментариев VSDoc в библиотеке javascript? Теперь у меня есть документация в комментариях VSDoc в файле javascript и в отдельном файле xml. И если я хочу что-то изменить, мне нужно изменить это в обоих местах. Было…
02 мар '11 в 04:11
1
ответ
Документация на основе кода Javascript для Enterprise Architect
Наша команда разрабатывает на AngularJS, node.js и mySql\Oracle. Как часть нашей прикладной документации, наша организация хочет, чтобы мы собрали наши пользовательские истории / варианты использования в Enterprise Architect, а затем сгенерировали д…
26 май '17 в 08:35
3
ответа
Создать схему JSON из машинописи
Я пытаюсь создать doc-генератор машинописного текста, но для этого мне нужно разобрать файл машинописного текста во что-то более удобочитаемое EX: "Command": { "description": "A command object for the command handler", "constructor": [ { "name": "na…
29 авг '17 в 12:50