Вопросы по теме 'documentation-generation'
Существуют ли инструменты документации для веб-служб SOAP?
Доступно множество коммерческих и бесплатных инструментов для проектирования, программирования и тестирования веб-сервисов. Но что доступно в области документации? Существуют ли инструменты, которые могут анализировать WSDL, а затем создавать...
4746 просмотров
schedule
17.11.2021
Название инструмента для комментариев к документации VB.NET
Как называется инструмент, который позволял коду VB.NET иметь встроенные комментарии документации (соответствующие комментариям документации C #), которые можно было извлечь с помощью этого инструмента?
Я просматриваю старый код; Эпоха Visual...
927 просмотров
schedule
20.09.2021
Как мне избавиться от пустых строк Perl's Pod, чтобы они не отображались с Pod :: Usage?
У меня есть следующий модуль, который я использовал с getopt :: long:
=head1 SYNOPSIS
foo [OPTION]... [URL]...
=head1 OPTIONS
=over 20
=item B<-h, --help>
Print a brief help message and exits.
=item B<-i, --input=FILE>
Reads...
241 просмотров
schedule
25.10.2021
Создание файлов HTML / справки из XML-документации VS 2010 C #
Я ищу хороший инструмент для создания файлов HTML / справки из моей XML-документации VS2010. Я нашел несколько коммерческих инструментов, например
Инструмент документации .Net
VSDocman
Я уверен, что их больше, я просто привожу эти два...
25129 просмотров
schedule
25.09.2021
Пикша: Задокументировать объявление с предполагаемой подписью типа?
Рассмотрим следующий модуль
{-# LANGUAGE RecordWildCards #-}
module Example (foo, fuh, fon, fuzz) where
import qualified FirstClassModule (Bar(foo,fuh,fon,fuzz), makeBar)
FirstClassModule.Bar {..} = FirstClassModule.makeBar parameter
parameter...
318 просмотров
schedule
27.10.2021
Есть ли способ одновременно сгенерировать несколько диаграмм последовательностей в Visual Studio 2010?
Я использую Visual Studio 2010 Ultimate для создания диаграмм последовательности для моего приложения, щелкнув правой кнопкой мыши имена методов и выбрав «Создать диаграмму последовательности ...». Есть ли способ сгенерировать сразу несколько...
237 просмотров
schedule
19.10.2021
Оглавление для подкарты DITA
Я недавно наткнулся на DITA и дурачился с ним, чтобы оценить, будет ли он применим для наших внутренних потребностей в документации. Я пытаюсь понять (и узнать), как правильно структурировать документ. Моя первоначальная настройка выглядит примерно...
920 просмотров
schedule
27.10.2021
Ruby-эквивалент генератора документации Sphinx?
В Ruby есть несколько хороших генераторов документов, таких как Yard, rDoc, даже Glyph. Дело в том, что Sphinx делает веб-сайты, PDF, epub, LaTex и т. Д. Все это делается в реструктурированном тексте.
Есть ли альтернатива этому в мире Ruby?...
3379 просмотров
schedule
27.09.2021
Документирование значений по умолчанию для дополнительных параметров в PHP с помощью phpDocumentor
С помощью phpDocumentor как документировать необязательный параметр, имеющий значение по умолчанию, подобное этому:
public function myMethod ($param = 1234)
{
// ...
}
Как мне написать тег @param в блоке документации, чтобы...
4324 просмотров
schedule
15.09.2021
Может ли Doxygen генерировать списки типа TODO для произвольных ключевых слов?
В Doxygen есть команда \ todo , которая создает документацию, отображаемую в функции, которую он находится в глобальном документе списка Todo, а также объединяется в него.
Можно ли продублировать или смоделировать это поведение для других...
909 просмотров
schedule
02.10.2021
Комментарий к документации Swift, эквивалент @code.
Мне известно о комментарии к документации Swift и многих его тегах, которые используются для документирования кода, например: param :,: return: и т. Д.
Но я не могу найти или выяснить эквивалент комментария в документации @code Objective-C для...
187 просмотров
schedule
16.11.2021
Как я могу исключить report.specification из отчета в Enterprise Architect?
Я пытаюсь создать словарь данных для пакета, но не могу понять, как исключить отчет, который является моим словарем данных.
Я получаю этот элемент:
в моем сгенерированном PDF-файле на последней странице:
Я пробовал «Создать...
198 просмотров
schedule
15.11.2021
Бесплатный инструмент для автоматического документирования XSD
Когда вы создаете XML для некоторой коммуникации или как файл конфигурации, вы, вероятно, захотите объяснить другим, как этот файл работает. Какой тег для чего используется.
Сначала вы создадите XSD, где определите, как создавать и использовать...
141 просмотров
schedule
01.10.2021
JavaScript Самодокументирующийся код, где инструменты API Docs?
Эти две концепции кажутся нелогичными. Есть одна сторона аргумента, которая видит вред, который комментарии наносят удобочитаемости, и нарушения DRY (если комментарии даже поддерживаются в актуальном состоянии). Однако подбросьте монету: необходимо...
950 просмотров
schedule
21.02.2022
Как консолидировать документацию на разных языках/средах?
Я разрабатываю библиотеку классов, предназначенную для решения широкого круга задач. Одна вещь об этой библиотеке заключается в том, что она будет изначально использоваться несколькими различными языками и средами. Например, будет версия C++,...
135 просмотров
schedule
02.03.2022
как делать документацию на phpdoc
Я выполнил эту команду в своей папке с кодом.
$ phpdoc -o HTML:frames:earthli -f user.php -t docs
Он создал папку docs и html-документацию пользователя. Теперь, если я хочу добавить еще файл в этот пакет, как мне добавить к нему.
Я...
486 просмотров
schedule
26.02.2022
Генератор документации gRPC
Поддерживает ли gRPC создание документации для таких сервисов, как Swagger? (или есть какой-то сторонний инструмент, который делает это?)
8813 просмотров
schedule
16.03.2022
Нерешенная сборка в Sandcastle
Я настроил Microsoft.OData.Client v 6.13.0 для Microsoft.OData.ProxyExtensions в файле shfbproj. Microsoft.OData.ProxyExtensions принимает любой OData.Client >= 6.11.0 на основе информации на веб-сайте MS, так что это должно быть хорошо. (Оба они на...
381 просмотров
schedule
04.04.2022
Ruby YARD: документирование реализации абстрактных методов
У меня есть типичный объектно-ориентированный шаблон: один базовый абстрактный класс (который определяет абстрактные методы) и несколько классов, которые реализуют эти абстрактные методы специфичным для класса способом.
Я привык писать документацию...
1607 просмотров
schedule
02.05.2022
SandCastle: Генерация ссылок для имени класса C#
Когда я использовал doxygen для своих проектов на C++, я просто написал:
/**
* I can refer to SomeClass or even SomeClass::someMethod() without special markup.
*/
Затем doxygen генерирует ссылки из строк «SomeClass» и...
1078 просмотров
schedule
03.06.2022
