Вопросы по теме 'autodoc'

Использование autodocs с шаблоном службы WCF REST 40
Я ищу инструмент документации для служб REST, созданный с использованием «Шаблон службы WCF REST 40», и наткнулся на Autodocs (http://autodocs.codeplex.com/), однако я не уверен, что они будут работать вместе .... Любой, кто заставил его работать,...
432 просмотров
schedule 15.02.2024

Как использовать документ Apple Header для автоматической генерации документации для разработки под iOS?
Я использовал инструмент Doxygen для создания документов. Но позже я узнал, что Apple предоставляет «Руководство по набору документации». Вот справочная ссылка:...
6529 просмотров
schedule 27.11.2022

Swagger-PHP для создания файла JSON для Swagger-UI
Я пытаюсь использовать Swagger-PHP для создания файлов JSON, чтобы я мог использовать его с Swagger-UI для автоматической документации. Я попробовал ссылку: - https://github.com/zircote/swagger-php Также я попытался обойти эту документацию по...
18509 просмотров
schedule 03.10.2022

Может ли Sphinx autodoc документировать namespace.module без документирования пространства имен?
Кодовая база, с которой я работаю, структурирована по схеме namespace . Я отвечаю за namespace.my_project , но я завишу от различных других модулей из namespace . Есть ли способ указать Sphinx (с autodoc) документировать namespace.my_project ,...
422 просмотров
schedule 31.10.2023

Можно ли использовать подсказку типа в python 3 для создания строки документации?
Мы можем указать типы параметров функции, используя docstring в python: def f1(a): """ :param a: an input. :type a: int :return: the input integer. :rtype: int """ return a Для f1 autodoc генерирует следующий...
2954 просмотров
schedule 16.01.2024

Изменить имя модуля в автодокументе Python Sphinx
Я ищу autodoc некоторые функции в модуле Python, используя autofunction . Предположим, например, что функции определены в mylib/funcs/a.py , и этот файл выглядит примерно так: def myfunc(arg): """ My function does something """ return...
532 просмотров
schedule 21.09.2022