DoxyS DoxyS — это простое и удобное в использовании приложение для документирования на C++, разработанное с очень стильным выводом. Этот инструмент поддерживает шаблоны, перегрузки, множество захватов. Просто запустите программу в исходной папке, и все готово. Как это использовать Удалите расширение .dox из файла DoxyS и дважды щелкните, чтобы выполнить его. Экран справки показывает первый шаг использования. Вы можете просмотреть эту библиотеку с помощью закладок (полезно для быстрого сканирования), сохранить как временные файлы или скомпилировать в html с помощью doxygen. Он доступен на bitbucket для личного использования. Это было протестировано в Linux. Версия 2.0.0 (2012-12-12) Вышел Известные ошибки Я получаю сообщение об ошибке «не удалось загрузить doxygen из '.'». Файл doxygen находится в том же каталоге, что и DoxyS. Как всегда в софте много багов, большинство из них не по вине автора. Применение Приложение простое и удобное в использовании (я уверен, что многие пользователи знакомы с таким инструментом). Первые шаги Двойной щелчок по файлу .cpp с именем «test.cpp» в DoxyS автоматически загрузит исходники DoxyS (он их загрузит и скомпилирует). Интерактивные примеры После загрузки исходников вы увидите экран справки: Затем вы можете нажать «Далее», чтобы увидеть второй шаг использования (по умолчанию расширение no.dox). Затем вы увидите список доступных примеров: Вы можете нажать на каждый из них, чтобы показать их. DoxyS может распознавать шаблоны/перегрузки и предоставляет вам выбор возможных решений для них (вы можете использовать этот выбор, чтобы сфокусировать DoxyS только на необходимом исходном коде). Компиляция в html Наконец, вы можете скомпилировать всю документацию в html. Как видно из изображений выше, вы получите легко читаемый, хорошо отформатированный вывод. DoxyS также может выбрать файл документации, который будет обработан, и создать из него html. Версия 2.0.0 (2012-12-12) Вышел Новые особенности Компиляция для исполняемых файлов Добавлен переключатель компилятора для принудительной компиляции для исполняемых файлов вместо статической библиотеки. По умолчанию теперь используется -static-libstdc++. Вы можете принудительно компилировать -------------------------------------------------- --- DoxyS был разработан в 2009 году. В то время я очень любил Texinfo, но так как мне нужно было использовать несколько разных версий дистрибутива TeX (MiKTeX, TeX Live, WinEdt,...). Я нашел действительно уродливый рабочий процесс "man doxy3.tex", "doxy3 -x scripts.tex", "scripts -f -i mf.tex" и так далее. Поэтому я разработал этот небольшой инструмент. Первая версия была специально для TeX. Это было чрезвычайно просто. Я сделал абстрактный интерфейс, и инструмент сгенерировал из него код TeX. На самом деле он назывался `dox' (doxy происходит от TeX, а `s' в немецком языке означает примечание). Самая большая проблема с ним заключалась в том, что он занимал много места. Если вы этого не сделали, вам пришлось печатать. Хорошо, мой источник не был `s'. Это был C++, и в нем использовался даже компилятор C++. Это было проблемой, и я решил переписать ее с нуля. На этот раз интерфейс был абстрактным, а позже его модифицировали так, что модель вообще не нужна. Конечно, есть еще структурная модель для описаний. На этот раз первоначальная версия также распространялась в виде пакета TeX. Первоначальная версия была расширена для работы с большим количеством различных генераторов кода для проектов C++ (Qt, GDK, GTK, wxWidgets), и инструмент назывался `doxygen' (doxy происходит от DoxyS, а gen происходит от генерации кода). Также была возможность использовать некоторые языковые модели. Вам нужно было загрузить языковой файл, прежде чем вы могли его использовать. Версия DoxyS для командной строки была добавлена в 2011 году. Доступно более 15 различных языков. Вы можете использовать полную клавиатуру или мышь для ввода описания. И вы можете использовать табуляцию. Поддерживаются описания перегрузки (порядок аргументов функции). Использование ДоксиС: ------------------ Первоначальная версия (с «dox») была разработана для использования с простым файлом конфигурации в TeX-документе. Новая версия приложения (с «doxygen») также позволяет использовать интерфейс с мастером (опять же с тем же файлом конфигурации) и возможность использовать другой файл конфигурации (с). Я настоятельно рекомендую вам использовать командную строку fb6ded4ff2
Related links:
Comments