Вопросы по теме 'documentation-generation'
Документирование кода библиотеки С++/CLI для использования с С# - лучшие инструменты и практики?
Я работаю над проектом, в котором библиотека С++/cli используется в основном из приложения С#.
Есть ли способ сделать комментарии кода в С++/cli видимыми для интеллекта С# в Visual Studio?
Предполагая, что это не так, как лучше всего...
11803 просмотров
schedule
14.06.2023
Создание исходной документации на C # для непрограммистов
Группа программного обеспечения, в которой я сейчас работаю, недавно решила начать документировать нашу кодовую базу. Первоначальный подход, который они использовали, заключался в использовании встроенного метода документирования с тройной косой...
618 просмотров
schedule
14.01.2022
Какой лучший инструмент или метод для написания комментариев к коду doxygen?
Публичные заголовочные файлы C++ должны быть снабжены большим количеством комментариев. Трудно форматировать и обертывать комментарии doxygen. Существует ли какой-либо инструмент форматирования?
С такими функциями, как автоматический перенос...
688 просмотров
schedule
15.06.2023
Используя Doxygen с C, вы комментируете прототип функции или определение? Или оба?
Я использую Doxygen с некоторым встроенным исходным кодом C. Учитывая пару файлов .c/.h, размещаете ли вы комментарии Doxygen в прототипе функции (файл .h) или в определении функции (файл .c) или дублируете их в обоих местах?
У меня проблема,...
21565 просмотров
schedule
15.05.2023
Как использовать phpDoc с перегруженными методами?
Допустим, у меня есть класс PHP с именем Color , его конструктор принимает различные параметры.
// hex color
$myColor = new Color('#FF008C');
// rgb channels
$myColor = new Color(253,15,82);
// array of rgb channels
$myColor = new...
4310 просмотров
schedule
26.05.2023
Плагин сайта maven не развертывает подпроекты в многомодульном проекте и не генерирует index.html
У меня есть многомодульный проект, для которого я хочу развернуть сайт, но похоже, что конфигурация развертывания моего сайта не наследуется дочерними модулями подпроекта.
parent
moduleA
модульB
В файловой системе они расположены...
2844 просмотров
schedule
03.05.2023
Документирование пространств имен с помощью Doxygen
У меня проблемы с распознаванием Doxygen пространств имен и модулей. Я считаю, что проблема заключается в том, размещать ли \addtogroup в пространстве имен или вне пространства имен.
Пример 1, вне пространства имен:
/*!
* \addtogroup...
29645 просмотров
schedule
07.04.2023
Как я могу документировать наборы данных с помощью roxygen?
Можно ли включить файлы .R в каталог данных моего пакета в процессе roxygen?
Я поместил несколько файлов .R в каталог данных. Когда они получены с помощью data (), они читают файлы необработанных данных и выполняют некоторые преобразования.
11937 просмотров
schedule
22.03.2022
WYSIWYG в Doxygen
Я работаю над довольно большим проектом, написанным на C. Идея заключалась в создании библиотеки модульных блоков, которые можно было бы повторно использовать на нескольких платформах. Каждый модуль связан со словесным документом в формате .docx...
2562 просмотров
schedule
23.10.2023
Использование LuaDoc с расширениями, отличными от .lua
В настоящее время я разрабатываю сценарии lua для нового приложения, для которого требуется расширение xx_lua . У меня luadoc отлично работает с расширениями .lua, и я знаю, что могу просто переименовать файлы в расширение lua, создать документы и...
227 просмотров
schedule
23.05.2022
Ошибка при создании документов API с помощью Enunciate
Я создал веб-сервис и хотел бы создать документацию для API. Поэтому я заглянул в Enunciate и скачал плагин maven enunciate. Однако я получаю следующую ошибку при компиляции, поскольку аннотации веб-сервиса находятся в моем классе интерфейса,...
1378 просмотров
schedule
29.07.2022
Автоматически документировать аннотации Spring @RequestMapping в одном месте?
Javadoc отлично подходит для сканирования всех исходных файлов и создания HTML-страниц для их просмотра. Мне было интересно, есть ли аналогичный инструмент, который просматривал бы все ваши контроллеры Spring и собирал все методы, которые были...
2290 просмотров
schedule
06.10.2023
Плагин автоматической документации для Aptana IDE [закрыт]
Мне было интересно, существует ли подключаемый модуль документации для Aptana (плагин Eclipse), который автоматически создавал схему документации для методов, функций, свойств и так далее. Я слышал о ScriptDoc, но не могу понять, как он работает....
3301 просмотров
schedule
14.06.2023
Используя документы Sphinx, как я могу указать форматы изображений PNG для сборок HTML и форматы изображений PDF для сборок Latex/PDF?
Используя генератор документов sphinx, я пытаюсь использовать изображения .png для HTML-сборок документации, а затем я хочу, чтобы изображения .svg использовались для сборок PDF/LATEx.
Кто-нибудь знает, как «пометить» разделы как «HTML build» и...
4453 просмотров
schedule
22.10.2022
Генератор комментариев/документации Visual Studio 2010 C#
Кто-нибудь знает о плагине Visual Studio 2010 С#, который будет:
позволяют мне легко изменить (или создать новый) шаблон комментариев xml. Мне нужно добавить в шаблон несколько пользовательских тегов. Например, когда я комментирую метод, я бы...
7290 просмотров
schedule
31.03.2022
Как сгенерировать документы для набора приложений в Erlang?
Мой вопрос
Как создать документацию в стиле OTP для нескольких приложений?
Объяснение
Я разработал библиотеку приложений в соответствии со структурой OTP и использую арматуру для компиляции кода.
Пример моей структуры каталогов показан...
885 просмотров
schedule
09.01.2023
Как получить многостраничный сайт из автоматического генератора GitHub Pages?
Я использую «Автоматический генератор» страниц GitHub и вижу, что он генерирует только один index.html и другие веб-ресурсы.
Как это работает, если я хочу создать многостраничный веб-сайт из других файлов уценки?
24951 просмотров
schedule
09.06.2023
Пользовательская/распределенная документация изменений с Doxygen
Я пытаюсь заставить следующую функцию работать с Doxygen.
Возможно ли это и как лучше это сделать?
Мы работаем с существующей кодовой базой Tcl, поставляемой с инструментом EDA, большая часть которого представляет собой код, который получает «из...
88 просмотров
schedule
25.02.2023
Как добавить внешние ссылки в юидок (grunt-contrib-yuidoc)
Я предполагаю, что я что-то упустил в документации yuidoc или неправильно понял использование. Кажется, я не могу найти способ включить ссылку на внешний сайт/страницу в свою документацию.
В блоке комментариев я хотел бы иметь что-то вроде этого:...
393 просмотров
schedule
25.02.2023
Предложение по документированию конечных точек для веб-службы Python Bottle
У меня есть часть моего API, которую я открываю с помощью Bottle ( http://bottlepy.org/docs/dev/index.html ).
Сейчас я пытаюсь задокументировать эти конечные точки для клиентов конечных пользователей и ищу хорошее решение. Я ищу что-то, что тесно...
214 просмотров
schedule
23.05.2024
