2
ответа

Мн Пакет / Пакет SQL Встроенная Документация

Я пытаюсь, более полно документируют наши пакеты базы данных как API. То, что мы хотели бы, является чем-то как JavaDocs для МН / SQL. Я видел пару инструментов там (pldoc, plsqldoc), но хотел бы...
вопрос задан: 5 September 2009 03:27
2
ответа

додзе js библиотека + jsdoc->, как зарегистрировать код?

Я хотел бы спросить Вас, как парни, разрабатывающие додзе, создают документацию? От ночных сборок можно получить несжатые js файлы со всеми комментариями, и я уверен, что существует некоторый вид...
вопрос задан: 19 August 2009 18:43
2
ответа

Функциональность типа автодокументации для Фортрана?

В прошлом я использовал Doxygen для C и C++, но теперь я был брошен на проект Фортрана, и я хотел бы получить быстрое весь взгляд затрагивания на архитектуру. В прошлом я нашел реверс...
вопрос задан: 19 May 2009 01:50
1
ответ

Документирование пространств имен с Doxygen

У меня есть проблемы с Doxygen, распознающим пространства имен и модули. Я полагаю, что проблема окружает, поместить ли \addtogroup в пространстве имен или вне пространства имен. Пример 1, снаружи...
вопрос задан: 26 March 2019 11:58
1
ответ

Как я могу зарегистрировать наборы данных с roxygen?

Действительно ли возможно включать.R файлы в каталог данных моего пакета в процессе roxygen? Я поместил несколько.R файлов в каталог данных. Когда они получены с данными (), они читают в сырых данных...
вопрос задан: 3 October 2018 21:59
1
ответ

Как Вы пишете свою документацию пакета? [закрытый]

Я не вполне выяснил разумный рабочий процесс для создания пакетов и записи их документации. Я хочу, чтобы как можно больше процесса (и документация) было автоматически сгенерировано...
вопрос задан: 31 December 2017 05:36
1
ответ

сделайте снимок экрана и визуально выделите сфокусированное управление

После счастливого использования программного обеспечения с открытым исходным кодом много лет я полагал, что пора отдать. И так как документация обычно является слабым местом для многих проектов, плюс мои навыки C# не находятся точно в...
вопрос задан: 4 May 2014 08:13
1
ответ

Используя RestructuredText и Сфинкса для включения предварительно отформатированного файла

Я пытаюсь заставить этот фрагмент работать: История версий---------------Это версии со временем::.. включайте:: ../../CHANGES.txt таким образом, используйте включать директиву так, чтобы файл был...
вопрос задан: 18 July 2011 18:00
1
ответ

Существует ли путь в Sphinx/Pygments, чтобы подчеркнуть, что одна или несколько строк кода в литерале включают?

В некоторых документах сфинкса я пишу, я включаю примеры кода из вспомогательного файла как так:.. literalinclude:: mymodule.py: pyobject: MyClass: linenos: Этот конкретный документ является учебным руководством...
вопрос задан: 18 July 2011 13:13
1
ответ

Используя сфинкса, чтобы автозарегистрировать класс Python, модуль

Я установил Сфинкса для документирования некоторых модулей Python и класса, я продолжаю работать. В то время как язык разметки выглядит очень хорошим, мне не удалось автозарегистрировать код Python. В основном, я...
вопрос задан: 18 July 2011 12:58
1
ответ

Каковы отношения между docutils и Сфинксом?

Кажется, существует множество инструментов документации для Python. Другой, что я натыкался, является epydoc. Кажется, что Сфинкс является фактическим стандартом, потому что это используется для генерации чиновника...
вопрос задан: 22 April 2011 16:56
1
ответ

плагин сайта знатока не развертывающиеся подпроекты в проекте мультимодуля или генерации index.html

У меня есть проект мультимодуля, для которого я хочу развернуть сайт, но кажется, что моя конфигурация развертывания сайта не наследована дочерними модулями подпроекта. родительский moduleA moduleB На...
вопрос задан: 5 January 2011 19:32
1
ответ

Сфинкс для php кодирует [закрытую] документацию

Сфинкс является библиотекой Python для генерации хорошей документации от ряда файлов форматированного текста ReST. Не инструмент использовал для полнотекстового поиска, я также полностью осведомлен о doxygen / phpdoc инструменты. Я...
вопрос задан: 5 January 2011 14:22
1
ответ

Используя WCF в.NET, как я могу сделать это автоматическим, генерируют документы SOAP как ASMX, сделал?

Я в настоящее время пишу веб-сервис с помощью WCF в VB.NET. Предыдущие веб-сервисы, которые я записал используемому ASMX, но я хотел изучить WCF и до сих пор он подходит. Я на самом деле предпочитаю способ, которым WCF делает вещи. Один...
вопрос задан: 7 June 2010 07:49
1
ответ

Doxygen, эквивалентный для Mathematica?

Как Вы помещаете дополнительную информацию в файл пакета Mathematica, как спецификация параметра doctests/example использование? До сих пор я только нашел:: строка использования и некоторая информация, о том, как...
вопрос задан: 7 May 2010 13:31
1
ответ

Отмечание “использования в качестве примера” в документации кода

Какова лучшая практика помещающего использования в качестве примера в документации кода? Существует ли стандартизованный способ? С @usage или @notes? Генераторы документа имеют тенденцию поддерживать это? Я знаю этот вопрос...
вопрос задан: 9 March 2010 12:11
1
ответ

Как я добавляю пользовательские свойства к документу в формате Word с.NET 4?

Используя.NET 4, как я добавляю пользовательские свойства к документу? Я предполагаю, что это проходит примерно так: WordApp//экземпляр Microsoft. Office. Interop. Word. Приложение.ActiveDocument....
вопрос задан: 24 February 2010 21:55
1
ответ

В xml документе я могу вставить ссылку на группу метода? Как?

В C# я могу присоединить документацию для свойств, методы, события, и так далее, непосредственно в коде с помощью Комментариев Документации XML. Я знаю, как вставить ссылку на конкретный метод: <...
вопрос задан: 15 September 2009 23:55
1
ответ

Doxygen может произвести участников просто в порядке объявления?

Какая опция Doxygen может полностью отключить участников сортировки типом (Частный / Общественность / Метод / Переменная) и произвести участников просто на основе порядка, в котором они были объявлены?
вопрос задан: 6 September 2009 14:16
1
ответ

Система документации, которая независима от языка программирования

Существует ли система документации, которая проста, генерирует некоторую дружественную, связанную гиперссылками документацию, для какого-либо языка с помощью признаков комментария? Такая система может просто быть дана...
вопрос задан: 30 August 2009 13:57
1
ответ

Как проигнорировать класс при генерации документации XML для проекта Visual Studio?

У меня есть Visual Studio (C#) проект, в котором включено свойство "XML documentation file". Это также имеет "Предупреждения обработки как ошибки" набор ко Всем. Существует один конкретный класс, который не имеет никакого XML...
вопрос задан: 31 July 2009 18:39
1
ответ

Показ отчетов HTML в панели инструментов CruiseControl

Я изучал конфигурацию CruiseControl недавно (я - полный новичок CC), и до сих пор я понимаю что различные отчеты XML, сгенерированные Вашим процессом сборки (например, mbunit.xml, ncover.xml...
вопрос задан: 7 May 2009 15:31
1
ответ

Инструмент поколения документации Oracle [закрывается]

Я хотел бы знать, знает ли кто-либо о хорошем инструменте к автоматическому, генерируют документацию оракула 9i схема базы данных. Я сделал reasearch и до сих пор нашел DBSribe (www.leadum.com), но у меня есть проблема...
вопрос задан: 2 April 2009 20:50
0
ответов

Как задокументировать метод с параметром (ами)?

Как задокументировать методы с параметрами, используя строки документации Python? РЕДАКТИРОВАТЬ: PEP 257 дает следующий пример: def complex (real = 0.0, imag = 0.0): "" "Сформируйте комплексное число. Аргументы ключевого слова: ...
вопрос задан: 2 July 2019 23:28
0
ответов

Создание файлов HTML / справки из документации VS 2010 C # XML

Я ищу хороший инструмент для создания файлов HTML / справки из моей документации VS2010 XML. Я нашел некоторые коммерческие инструменты, такие как инструмент документации .Net VSDocman Я уверен, что их гораздо больше, я ...
вопрос задан: 24 March 2019 16:51
0
ответов

Преобразование phpdoc в набор документов для использования Dash

Я пытаюсь получить документацию Magento в формате, который я могу использовать в Dash. В статье на сайте Dash описано, как импортировать ряд видов документации в нужный формат,...
вопрос задан: 18 March 2019 14:22
0
ответов

Doxygen: автоматическая генерация таблицы из пользовательских атрибутов

Я хочу иметь следующую таблицу сделанную doxygen: Имя | Атрибут_А | Атрибут_B | Атрибут_C ОШИБКА_1 | аа | бб | cc ERROR_2 | ааа | BBB | СКК из ...
вопрос задан: 1 March 2019 20:28
0
ответов

Sphinx :Список поддерживаемых языков для выделения?

Я использую Sphinx для документации кода и использую несколько языков в коде, я хотел бы настроить подсветку для всего этого кода. Sphinx кратко упоминает несколько поддерживаемых им языков (...
вопрос задан: 2 February 2019 00:40
0
ответов

Инструменты документации для API RPC

Есть множество хороших инструментов для исходного кода и документации API (doxygen, Headerdoc, Sphinx, и это лишь некоторые из них). Однако ни один из них не кажется особенно хорошим в создании ...
вопрос задан: 23 December 2018 10:32
0
ответов

Следует ли включать геттеры и сеттеры в диаграмме классов?

Я должен нарисовать диаграмму классов для моего приложения JSF для документации проекта. Итак, у меня есть много классов как управляемых bean-компонентов со многими атрибутами, поэтому много геттеров и сеттеров. Когда я ...
вопрос задан: 4 December 2018 23:02