Вопросы по теме 'documentation-generation'
Как узнать, в каком модуле выполняется мой код?
В течение очень долгого времени, когда у меня есть обработчик ошибок, я заставляю его сообщать, в каком проекте, модуле и процедуре возникла ошибка. Я всегда добивался этого, просто сохраняя их имена через константы. Я знаю, что в классе вы получаете...
1924 просмотров
schedule
17.06.2022
Широко распространенные методы документирования исходного кода PHP в автоматическом режиме?
Возможный дубликат: Автоматическое создание документации PHP?
Я новичок в PHP, и моя текущая работа требует от меня очень быстрого изучения языка.
Я приверженец документации. Я даже люблю писать документацию. Я знаком с принятым...
1273 просмотров
schedule
15.06.2023
Генератор документации JavaScript, совместимый с jQuery
Мне нужно выбрать генератор документации (похожий на jdoc в java или rdoc в ruby) для моего проекта javascript, который (созданный с помощью jquery, подчеркивания и магистрали)
Кандидаты:
инструментарий jsdoc
pdoc
натуральные документы...
8815 просмотров
schedule
26.11.2022
Автоматическое создание документации для всего содержимого пакета Python
Я пытаюсь автоматически сгенерировать базовую документацию для своей кодовой базы с помощью Sphinx. Однако у меня возникли трудности с указанием Sphinx рекурсивно сканировать мои файлы.
У меня есть кодовая база Python со структурой папок, например:...
25849 просмотров
schedule
21.09.2022
Можно ли задокументировать XML с помощью Doxygen, Sandcastle или других генераторов документации?
В настоящее время я использую Sandcastle, Doxygen и JavaDoc для создания документации для написанного мной кода. Можно ли документировать схемы XML с помощью этих пакетов? Если нет, то есть ли какие-нибудь (желательно бесплатные!) Пакеты, которые...
4325 просмотров
schedule
29.08.2022
Как определить, код какого языка я хочу видеть в документации Sandcastle HFB?
это довольно сложно: я использую Sandcastle Help File Builder для создания документации для моего проекта C # из Visual Studio 2010. Я хочу сделать код видимым только для C #, но по умолчанию также видны фрагменты кода для C ++ и Visual Basic, как...
678 просмотров
schedule
20.03.2023
Использование Swagger в нескольких браузерах
Кто знает проблему? Кажется, Swagger не поддерживает IE. Я развернул пример Swagger следующим образом в Tomcat. Пример хорошо работает в Google Chrome и Firefox. https://github.com/wordnik/swagger-core/tree/master/samples/no-server
Но пример...
1059 просмотров
schedule
28.09.2022
Как создать документацию с помощью Pydoc?
Я пытаюсь создать документ из моего модуля. Я использовал pydoc из командной строки в Windows 7, используя Python 3.2.3:
python "<path_to_pydoc_>\pydoc.py" -w myModule
Это привело к тому, что моя оболочка была заполнена текстом, по...
145522 просмотров
schedule
21.04.2023
YUIDoc, лучший способ документирования объектов «вернуть это»
Я впервые использую YUIDoc в новом проекте. Я создаю объекты (изолированные друг от друга), которые будут управлять созданием и отслеживанием своих собственных форм, которые позже выводятся на экран.
У меня есть основной объект — «MakeOneOfThese»...
894 просмотров
schedule
30.10.2022
Доксиген оптимизация
Я пытаюсь понять, как я могу оптимизировать Doxygen для запуска моего проекта в разумные сроки. Я попытался использовать файлы тегов и разделил свой проект на подпроекты, чтобы я мог распараллелить/распределить нагрузку запуска Doxygen. Однако...
659 просмотров
schedule
31.05.2022
Можно ли указать jsdoc искать документацию по этому коду в отдельном от исходного кода файле?
Я хотел бы, чтобы встроенные комментарии были как можно короче, поскольку, по моему опыту, комментарии длиной более 3 или 4 строк имеют тенденцию замалчиваться, создавая много ненужных строк «прочитайте руководство».
По наследству я обязан...
3769 просмотров
schedule
15.04.2023
Анализ определений bean-компонентов Spring
Наше приложение экспортирует свою конфигурацию в виде нескольких наборов компонентов Spring.
Я не могу контролировать, как это происходит.
Я хочу написать что-то, что документирует зависимости между элементами конфигурации, определенными в этих...
119 просмотров
schedule
19.01.2024
написание документации угловых проектов с использованием grunt-ngdocs
Я хочу задокументировать угловой проект, над которым я работаю. Я пробовал grunt-ngdocs . Это выглядит просто с меньшим количеством настроек, а начальные испытания выглядят красиво и многообещающе. Но я не смог найти хороший ресурс о его полном...
1567 просмотров
schedule
18.10.2022
Обзор пакета Dox (инструмент документирования haxe)
Есть ли способ сгенерировать то, что Java вызывает комментарии к пакету с Dox ?
91 просмотров
schedule
19.09.2022
Генератор документации для файлов модели NetLogo
Недавно я наткнулся на генератор документации Doxygen для C++ и особенно Qt Code. Он генерирует документацию в различных форматах (html, pdf, ...) и включает в себя такие вещи, как Model-Flow-Digrams. Примитивы документации используются...
96 просмотров
schedule
13.05.2023
Существует ли инструмент для автоматической визуализации встроенного потока управления исходным кодом проекта?
Я хотел бы иметь возможность использовать инструмент, который позволяет вам визуализировать потоки управления программы в контексте ее исходного кода. Чтобы уточнить, такой инструмент должен в основном показывать, что происходит в программе, выдавая...
425 просмотров
schedule
17.07.2022
Документация с гиперссылками на диаграммы в Enterprise Architect?
Я изо всех сил пытаюсь включить всю необходимую (и только необходимую) информацию в документацию моего проекта Enterprise Architect. Точно: мы смоделировали различные требования и отобразили исходные «стандарты» для этих требований на наших...
2007 просмотров
schedule
16.08.2022
расширение jsDoc для обработки пользовательских тегов
Я хочу расширить jsdoc (особенно с помощью docstrap). У меня есть приложение nodeJS, и я хочу разделить навигацию jsdoc на контроллеры, представления и т. Д. Мне удалось в определенной степени с этим справиться, создав свои собственные теги, такие...
312 просмотров
schedule
14.04.2022
Почему Doxygen так недружелюбен к мобильным телефонам?
Doxygen кажется лучшим выбором для документации кода на C++ (и многих других языках), но каждый раз, когда я просматриваю сгенерированный Doxygen документ с моего телефона, сайт буквально не прокручивается, текст ужасно мал...
Почему ?
Я работаю...
1754 просмотров
schedule
27.11.2022
Как создать легенду с цветами в PlantUML?
Я хочу раскрасить классы на моей диаграмме классов на основе определенных критериев, а затем отобразить легенду, которая будет выглядеть примерно так:
Если бы я мог добавить таблицу HTML в legend и endlegend PlantUML, я мог бы добиться...
8314 просмотров
schedule
12.07.2022
