Вопросы по теме 'documentation-generation'
Как использовать встроенные комментарии для документирования членов в .NET?
Как я могу задокументировать участника, встроенного в .Net? Позволь мне объяснить. Большинство инструментов, которые извлекают документацию из комментариев, поддерживают некоторую встроенную документацию, в которую вы можете добавить краткую...
4609 просмотров
schedule
16.02.2023
Автор в вики, создание документов PDF, файлов CHM или встроенной справки
Кто-нибудь знает о вики или вики-плагине, который генерирует PDF-файл или файл CHM, охватывающий всю вики?
Я хотел бы иметь контроль над оглавлением.
Я хотел бы, чтобы внутренние и внешние ссылки работали.
В идеале разрешить настройку...
2475 просмотров
schedule
22.04.2023
Инструмент документации из единого источника
Какие OSS (или бесплатные) инструменты доступны для составления единого источника документации, которую можно использовать для генерировать мануалы? В частности, в следующих форматах:
HTML-сайт
PDF-документ
Встроенный (внутри приложения;...
1473 просмотров
schedule
17.06.2022
dojo js library + jsdoc -> как документировать код?
Я хотел бы спросить вас, как ребята, разрабатывающие dojo, создают документацию?
Из ночных сборок вы можете получить несжатые файлы js со всеми комментариями, и я уверен, что есть какой-то документирующий скрипт, который сгенерирует из него...
2525 просмотров
schedule
03.06.2022
Может ли Doxygen выводить членов исключительно в порядке объявления?
Какая опция Doxygen может полностью отключить сортировку элементов по типу (Private/Public/Method/Variable) и выводить элементы исключительно в порядке их объявления?
4695 просмотров
schedule
23.05.2022
Создание документации по коду PHP с помощью Sphinx?
Sphinx — это библиотека Python для создания красивой документации из набора текстовых файлов в формате ReST. Не тот инструмент, который используется для полнотекстового поиска
Я также полностью осведомлен об инструментах doxygen/phpdoc. Я пытаюсь...
10867 просмотров
schedule
14.11.2022
Инструменты для создания диаграммы базы данных/диаграммы ER из существующей базы данных Oracle?
Ищете инструменты (платформа Windows) для создания ER-диаграммы (или аналогичной) из существующей базы данных Oracle. Есть ли хорошие бесплатные или недорогие инструменты?
91960 просмотров
schedule
26.05.2023
Документатор PHP 5.3?
Возможный дубликат: Что-нибудь лучше, чем PHPDoc?
Мне было интересно, есть ли доступное решение для документации, поддерживающее PHP 5.3. У нас две проблемы с phpDocumentor. Во-первых, ему не хватает поддержки 5.3. Во-вторых, он...
1557 просмотров
schedule
29.12.2022
Как документировать REST API на основе Symfony (аналогично изложению возможностей документации)
Если у меня есть сервис на основе REST, написанный на фреймворке Symfony [symfony-project.org] (т. е. PHP), существуют ли какие-нибудь достойные инструменты/фреймворки, которые будут анализировать мой код и генерировать документацию по API?...
1953 просмотров
schedule
25.01.2024
Используя WCF в .NET, как я могу заставить его автоматически создавать документы SOAP, как это сделал ASMX?
В настоящее время я пишу веб-службу с использованием WCF в VB.NET.
Предыдущие веб-службы, которые я писал, использовали ASMX, но я хотел изучить WCF, и пока все идет хорошо. На самом деле я предпочитаю то, как работает WCF.
Однако я скучаю по...
1244 просмотров
schedule
24.10.2022
Как вы пишете пакетную документацию?
Я не совсем понял разумный рабочий процесс для создания пакетов и написания их документации.
Я хочу, чтобы как можно больше процесса (и документации) генерировалось автоматически.
Очевидный способ сделать это — использовать package.skeleton...
5000 просмотров
schedule
30.06.2023
Импорт файлов комментариев .NET XML doc в проект Doxygen
Кто-нибудь знает, есть ли способ импортировать файлы комментариев .NET XML doc в проект Doxygen?
У меня есть проект, в котором используются сборки с файлами комментариев XML. Я бы хотел, чтобы Дойген взял эту документацию и добавил ее в мой...
254 просмотров
schedule
05.02.2023
Проблема генерации Javadoc в Eclipse
У меня проблема с генерацией javadoc в eclipse. Заранее спасибо, что нашли время. Вот что происходит: я перехожу к Project>Generate Javadoc... , выбираю все файлы в проекте и нажимаю «Готово».
Затем Eclipse идет и, похоже, делает свое дело....
2526 просмотров
schedule
27.08.2022
Как получить единый документ PDF из Doxygen?
Когда я создаю документацию Doxygen в формате PDF, я получаю множество разных файлов с одной диаграммой в каждом. Можно ли получить один PDF-документ, организованный в виде книги, примерно как HTML-версию? Is можно ли получить его автоматически,...
81196 просмотров
schedule
10.04.2022
Скаладок [вариант использования]
Почему описания некоторых методов в Scaladoc начинаются с [use case] ?
Пример: scala.collection.immutable.StringOps.++
Это просто заполнитель, который нужно заменить в будущем?
1900 просмотров
schedule
09.08.2022
Создание документации по исходному коду XMLDoc Delphi
Я предполагаю, что XML и Руководство по документации Delphi становятся стандартом де-факто для документирования исходного кода. Комментарии. Это хорошо. Плохо то, что я не могу найти генератор документации Delphi (бесплатный или платный), который...
3677 просмотров
schedule
14.06.2022
Как пометить устаревшие классы/методы на выходе с помощью sandcastle
Я создаю документацию API с помощью Sandcastle. В коде есть несколько классов и методов, которые помечены как устаревшие. Теперь я хочу, чтобы в выводе API-документации эти методы были четко отмечены (перечеркнутым или другим маркером). Однако...
1095 просмотров
schedule
22.12.2023
Как создать документацию только в формате HTML из веб-проекта aspdotnet?
Я прокомментировал весь код соответствующими тегами документации ms xml. Как создать документацию только в формате HTML (или в формате pdf) для всего закомментированного кода? Я скачал sandcastle, но не могу понять, как перейти к следующему шагу....
265 просмотров
schedule
16.10.2023
Настройка замка из песка — переход на веб-страницу отменен
Я пытаюсь использовать Sandcastle Help File Builder, но не могу заставить его работать. Вот что я сделал:
1) установил программу; работает как обычно
2) включил xml в проекте, я хочу, чтобы документация для него создавалась в /bin
3) создал...
1010 просмотров
schedule
09.06.2023
VS2010: автоматически созданный файл документации XML не обновляется
У меня есть проект С# в vs2010, который генерирует файл документации XML, где я установил выходной путь сгенерированного файла в выходной путь проекта.
Моя проблема в том, что файл не обновляется, когда путь к файлу документа совпадает с выходным...
2409 просмотров
schedule
21.10.2022
