Я пытаюсь, более полно документируют наши пакеты базы данных как API. То, что мы хотели бы, является чем-то как JavaDocs для МН / SQL. Я видел пару инструментов там (pldoc, plsqldoc), но хотел бы...
Я хотел бы спросить Вас, как парни, разрабатывающие додзе, создают документацию? От ночных сборок можно получить несжатые js файлы со всеми комментариями, и я уверен, что существует некоторый вид...
В прошлом я использовал Doxygen для C и C++, но теперь я был брошен на проект Фортрана, и я хотел бы получить быстрое весь взгляд затрагивания на архитектуру. В прошлом я нашел реверс...
У меня есть проблемы с Doxygen, распознающим пространства имен и модули. Я полагаю, что проблема окружает, поместить ли \addtogroup в пространстве имен или вне пространства имен. Пример 1, снаружи...
Действительно ли возможно включать.R файлы в каталог данных моего пакета в процессе roxygen? Я поместил несколько.R файлов в каталог данных. Когда они получены с данными (), они читают в сырых данных...
Я не вполне выяснил разумный рабочий процесс для создания пакетов и записи их документации. Я хочу, чтобы как можно больше процесса (и документация) было автоматически сгенерировано...
После счастливого использования программного обеспечения с открытым исходным кодом много лет я полагал, что пора отдать. И так как документация обычно является слабым местом для многих проектов, плюс мои навыки C# не находятся точно в...
Я пытаюсь заставить этот фрагмент работать: История версий---------------Это версии со временем::.. включайте:: ../../CHANGES.txt таким образом, используйте включать директиву так, чтобы файл был...
В некоторых документах сфинкса я пишу, я включаю примеры кода из вспомогательного файла как так:.. literalinclude:: mymodule.py: pyobject: MyClass: linenos: Этот конкретный документ является учебным руководством...
Я установил Сфинкса для документирования некоторых модулей Python и класса, я продолжаю работать. В то время как язык разметки выглядит очень хорошим, мне не удалось автозарегистрировать код Python. В основном, я...
Кажется, существует множество инструментов документации для Python. Другой, что я натыкался, является epydoc. Кажется, что Сфинкс является фактическим стандартом, потому что это используется для генерации чиновника...
У меня есть проект мультимодуля, для которого я хочу развернуть сайт, но кажется, что моя конфигурация развертывания сайта не наследована дочерними модулями подпроекта. родительский moduleA moduleB На...
Сфинкс является библиотекой Python для генерации хорошей документации от ряда файлов форматированного текста ReST. Не инструмент использовал для полнотекстового поиска, я также полностью осведомлен о doxygen / phpdoc инструменты. Я...
Я в настоящее время пишу веб-сервис с помощью WCF в VB.NET. Предыдущие веб-сервисы, которые я записал используемому ASMX, но я хотел изучить WCF и до сих пор он подходит. Я на самом деле предпочитаю способ, которым WCF делает вещи. Один...
Как Вы помещаете дополнительную информацию в файл пакета Mathematica, как спецификация параметра doctests/example использование? До сих пор я только нашел:: строка использования и некоторая информация, о том, как...
Какова лучшая практика помещающего использования в качестве примера в документации кода? Существует ли стандартизованный способ? С @usage или @notes? Генераторы документа имеют тенденцию поддерживать это? Я знаю этот вопрос...
Используя.NET 4, как я добавляю пользовательские свойства к документу? Я предполагаю, что это проходит примерно так: WordApp//экземпляр Microsoft. Office. Interop. Word. Приложение.ActiveDocument....
В C# я могу присоединить документацию для свойств, методы, события, и так далее, непосредственно в коде с помощью Комментариев Документации XML. Я знаю, как вставить ссылку на конкретный метод: <...
Какая опция Doxygen может полностью отключить участников сортировки типом (Частный / Общественность / Метод / Переменная) и произвести участников просто на основе порядка, в котором они были объявлены?
Существует ли система документации, которая проста, генерирует некоторую дружественную, связанную гиперссылками документацию, для какого-либо языка с помощью признаков комментария? Такая система может просто быть дана...
У меня есть Visual Studio (C#) проект, в котором включено свойство "XML documentation file". Это также имеет "Предупреждения обработки как ошибки" набор ко Всем. Существует один конкретный класс, который не имеет никакого XML...
Я изучал конфигурацию CruiseControl недавно (я - полный новичок CC), и до сих пор я понимаю что различные отчеты XML, сгенерированные Вашим процессом сборки (например, mbunit.xml, ncover.xml...
Я хотел бы знать, знает ли кто-либо о хорошем инструменте к автоматическому, генерируют документацию оракула 9i схема базы данных. Я сделал reasearch и до сих пор нашел DBSribe (www.leadum.com), но у меня есть проблема...
Как задокументировать методы с параметрами, используя строки документации Python? РЕДАКТИРОВАТЬ: PEP 257 дает следующий пример: def complex (real = 0.0, imag = 0.0): "" "Сформируйте комплексное число. Аргументы ключевого слова: ...
Я ищу хороший инструмент для создания файлов HTML / справки из моей документации VS2010 XML. Я нашел некоторые коммерческие инструменты, такие как инструмент документации .Net
VSDocman Я уверен, что их гораздо больше, я ...
Я пытаюсь получить документацию Magento в формате, который я могу использовать в Dash. В статье на сайте Dash описано, как импортировать ряд видов документации в нужный формат,...
Я использую Sphinx для документации кода и использую несколько языков в коде, я хотел бы настроить подсветку для всего этого кода. Sphinx кратко упоминает несколько поддерживаемых им языков (...
Есть множество хороших инструментов для исходного кода и документации API (doxygen, Headerdoc, Sphinx, и это лишь некоторые из них). Однако ни один из них не кажется особенно хорошим в создании ...
Я должен нарисовать диаграмму классов для моего приложения JSF для документации проекта. Итак, у меня есть много классов как управляемых bean-компонентов со многими атрибутами, поэтому много геттеров и сеттеров. Когда я ...