Бағдарламалық кодтан құжаттама жасауға арналған тегін бағдарламалық құрал
Doxygen
Doxygen – бағдарлама кодынан автоматты түрде құжаттама жасауға арналған тегін бағдарлама. Код талдау, сызбалар жасау, өзіндік анықтамалар құру мүмкіндігі бар.
Ағылшыншамен салыстырыңыз: абзацты басыңыз — түпнұсқа терезеде ашылады. Абзац астындағы EN түймесі оны мәтін ішінде көрсетеді.
Мазмұны
Кіріспе
Doxygen (/dɒk/s/i/dʒ/ən/ DOKsee jən) – бағдарламалық кодтан құжаттама жасауға арналған және статикалық талдау құралы. Құжаттама генераторы ретінде қолданғанда, Doxygen кодтың ішіндегі арнайы форматталған түсініктемелерден ақпаратты шығарып алады. Талдау үшін пайдаланғанда, Doxygen код құрылымының схемаларын және графиктерін жасау үшін талдау ағашын қолданады. Doxygen құжаттама мен кодты өзара байланыстырып, сілтемелей алады, соның арқасында құжатты оқыған адам нақты кодқа оңай жүгіне алады. Doxygen – GNU General Public License нұсқасы 2 (GPLv2) талаптарымен таратылатын тегін бағдарламалық жасақтама.
Free software for generating software documentation from source code
Doxygen ('/d//ɒ//k//s//i//dʒ//ən/ DOKsee jən) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially formatted comments within the code. When used for analysis, Doxygen uses its parse tree to generate diagrams and charts of the code structure. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code. Doxygen is free software, released under the terms of the GNU General Public License version2 (GPLv2).
Дизайн
Javadoc сияқты, Doxygen деректерді код файлдарындағы түсініктемелерден шығарып алады. Javadoc синтаксисінен өзге, Doxygen Qt құралдар жинағында қолданылатын құжаттама тегтерін де қолдайды және HyperText Markup Language (HTML), Microsoft Compiled HTML Help (CHM), Rich Text Format (RTF), Portable Document Format (PDF), LaTeX, PostScript немесе man беттері түрінде нәтижелерді ұсына алады.
Like Javadoc, Doxygen extracts documentation from source file comments. In addition to the Javadoc syntax, Doxygen supports the documentation tags used in the Qt toolkit and can generate output in HyperText Markup Language (HTML) as well as in Microsoft Compiled HTML Help (CHM), Rich Text Format (RTF), Portable Document Format (PDF), LaTeX, PostScript or man pages.
Қолданылуы
Doxygen қолдайтын бағдарламалау тілдеріне C, C++, C#, D, Fortran, IDL, Java, Objective C, Perl, PHP, Python және VHDL жатады.
Programming languages supported by Doxygen include C, C++, C#, D, Fortran, IDL, Java, Objective C, Perl, PHP, Python, and VHDL.
Оттегі көзі және дамуы
Doxygen дереккөздері қазіргі уақытта GitHub-та орналасқан, онда басты әзірлеуші Димитри ван Хиш "doxygen" пайдаланушы атымен үлес қосады. Doxygen C++ тілінде жазылған және шамамен 300 000 код жолынан тұрады. Лексикалық талдау үшін стандартты Lex құралы (немесе оның орнына Flex) шамамен 35 000 жолды lex скрипті арқылы іске қосылады. Yacc талдау құралы (немесе оның орнына Bison) да пайдаланылады, бірақ тек шағын міндеттер үшін; тілдің басым бөлігін талдау түпкі C++ кодымен жүзеге асырылады. Құрастыру процесі CMake-ке негізделген, сонымен қатар бірнеше Python скрипттерін де қамтиды.
The Doxygen sources are currently hosted at GitHub, where the main developer, Dimitri van Heesch, contributes under the user name "doxygen". Doxygen is written in C++, and consists of around 300,000 source lines of code. For lexical analysis, the standard tool Lex (or its replacement Flex) is run via approximately 35,000 lines of lex script. The parsing tool Yacc (or its replacement Bison) is also used, but only for minor tasks; the bulk of language parsing is done by native C++ code. The build process is based on CMake and also involves some Python scripts.