У меня есть проект, который был разработан SOAP. Он был открыт на затмении. Я хотел бы использовать программное обеспечение для автоматического создания документа (html-файл) для учебника разработчика. Он был создан комментарием выше функции.Программное обеспечение авто gen document на Eclipse
Спасибо,
Использование кислорода в качестве Штефана уже сказал, это бесплатно, и вы можете получить его здесь: http://www.stack.nl/~dimitri/doxygen/download.html
Сформировать документацию из исходного кода
Doxygen является стандартом де-факто инструментом генерирующую документацию из аннотированных источников C++, но также поддерживает другие популярные языки программирования, такие как C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Micro мягкий и UNO/OpenOffice ароматизаторов), Fortran, VHDL, Tcl, и в некоторой степени D.
Doxygen может помочь вам в трех направлениях:
Он может генерировать онлайн-просмотрщик документации (в формате HTML) и/или автономное справочное руководство (в) из набора документов с исходными документами. Существует также поддержка для генерации вывода в RTF (MS-Word), PostScript, гиперссылках PDF, сжатых HTML и справочных страницах Unix. Документация извлекается непосредственно из источников, что делает его намного проще, чтобы документация соответствовала исходному коду. Вы можете настроить doxygen для извлечения структуры кода из недокументированных исходных файлов. Это очень полезно для быстрого поиска вашего в больших дистрибутивах. Doxygen также может визуализировать отношения между различными элементами путем включения диаграмм зависимостей , диаграмм наследования и диаграмм совместной работы, которые являются , все созданные автоматически. Вы также можете использовать doxygen для создания нормативной документации (как я сделал для руководства пользователя doxygen и ). Doxygen разработан под Mac OS X и Linux, но является настройкой, которая будет очень переносимой. В результате, он работает на большинстве других Unix вкусов. Кроме того, доступны исполняемые файлы для Windows.
он, вероятно, использует doxygen – stefan
Если вы хотите написать учебник разработчика, просто напишите его. Автоматически созданная документация обычно не приводит к хорошим учебным пособиям - просто другой взгляд на полный исходный код. Предоставьте своим пользователям пользу и напишите им что-то приятное и лаконичное. –