建站
咨詢
售后
建站咨詢
新聞中心
Doxygen是一款常用的自動(dòng)生成文檔的工具，就像JavaDoc用于Java語言，Doxygen可以用于多種編程語言，如C++, Java, Python等等。在Linux環(huán)境下，Doxygen能夠方便快捷的生成文檔，這篇文章將介紹如何在Linux環(huán)境下下載和安裝Doxygen。
你所需要的網(wǎng)站建設(shè)服務(wù)，我們均能行業(yè)靠前的水平為你提供.標(biāo)準(zhǔn)是產(chǎn)品質(zhì)量的保證，主要從事成都網(wǎng)站制作、成都網(wǎng)站建設(shè)、企業(yè)網(wǎng)站建設(shè)、手機(jī)網(wǎng)站開發(fā)、網(wǎng)頁設(shè)計(jì)、品牌網(wǎng)站建設(shè)、網(wǎng)頁制作、做網(wǎng)站、建網(wǎng)站。創(chuàng)新互聯(lián)擁有實(shí)力堅(jiān)強(qiáng)的技術(shù)研發(fā)團(tuán)隊(duì)及素養(yǎng)的視覺設(shè)計(jì)專才。
1. 下載Doxygen
需要訪問Doxygen的官方網(wǎng)站，從下面的鏈接下載最新的Doxygen版本：
https://www.doxygen.nl/download.html
在下載界面，可以選擇穩(wěn)定版本或者開發(fā)版本等等，將最新版本的下載鏈接復(fù)制，然后在Linux的終端中使用wget命令下載：
“`
wget https://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.20.src.tar.gz
“`
其中，版本號(hào)不一定是這個(gè)，應(yīng)該替換成下載鏈接中的版本號(hào)。下載完成后，解壓縮文件：
“`
tar xzvf doxygen-1.8.20.src.tar.gz
“`
2. 安裝Doxygen
解壓完成后，會(huì)生成一個(gè)名為doxygen-1.8.20的文件夾，進(jìn)入該文件夾，并使用以下命令進(jìn)行安裝：
“`
cd doxygen-1.8.20
mkdir build
cd build
cmake -G “Unix Makefiles” ..
make
sudo make install
“`
以上命令將在Linux環(huán)境中編譯和安裝Doxygen。在編譯和安裝期間，可能需要一些額外的依賴項(xiàng)，如cmake、g++等等，需要根據(jù)提示進(jìn)行安裝。
3. 驗(yàn)證安裝
安裝完成后，可以使用Doxygen生成任何程序的文檔。為了驗(yàn)證Doxygen的安裝，可以使用以下命令生成一個(gè)簡(jiǎn)單的文檔：
“`
doxygen -g config_file
“`
在控制臺(tái)上運(yùn)行以上命令，Doxygen將生成一個(gè)名為config_file的配置文件，用于生成文檔。然后使用以下命令生成文檔：
“`
doxygen config_file
“`
生成的文檔位于doxygen-1.8.20文件夾中的doc文件夾下。
4.
本文介紹了在Linux環(huán)境下下載和安裝Doxygen的詳細(xì)過程，以及如何使用Doxygen生成文檔。Doxygen是非常方便的文檔生成工具，可以用于多種編程語言，通過本文的介紹，讀者可以輕松方便的使用Doxygen并生成文檔。
相關(guān)問題拓展閱讀：
- 如何利用doxygen生成pdf文檔
- 幫我推薦一本書，有關(guān)FLASH游戲制作的或c++游戲制作的書.謝謝！我是菜鳥啊！
如何利用doxygen生成pdf文檔
在代碼中加入文檔 這個(gè)是之一步,也是最重要的一步,直接影響著文檔的優(yōu)與劣.
Doxygen是一個(gè)比較成熟的工具了,它有非常詳細(xì)且專業(yè)的文檔.
文檔是寫在代碼當(dāng)中的,以注釋塊的形式,為了區(qū)分代碼中的正常注釋,訪文檔需要余亮用特殊的形式的注釋塊來呈現(xiàn).Doxygen支持多種文檔注釋塊:
Javadoc形式的:/** * … */QT形式的/*! * … */或者,這樣/// /// … ///或者,這樣//! //! .. //!后二種有點(diǎn)非主流,不建議使用.推薦使用前面二種.當(dāng)然,配置了某些特殊的選項(xiàng)也可以使用其他格式.
當(dāng)Doxygen看到這種形式的注釋塊時(shí)就會(huì)把它從代碼中抽取出來,生成HTML形式的文檔.
為了讓文檔更且有可讀性,表達(dá)出更多的信息,Doxygen就定義了很多的命令,常用的有:
\file 告訴Doxygen這是某個(gè)文件的文檔塊\enum 給一個(gè)enum類型加文檔\struct 給一個(gè)結(jié)構(gòu)體加文檔\param 函數(shù)的參數(shù)\return 函數(shù)的返回值\see 交叉參考\brief 簡(jiǎn)介,用于概覽時(shí)控制在一行以內(nèi),可以空一行,然后寫更多的詳細(xì)的內(nèi)容\code \endcode 示例代碼\note 注意事項(xiàng)\par HTML中的 需要注意的是,這些命令也可以用javadoc格式的來寫如@file, @enum, @return等.但建議用標(biāo)準(zhǔn)格式,因?yàn)閈只需要敲一下,而@需要敲二下,另外就是并不是所有的命令都支持javadoc格式.
還有就是如果想寫交叉引用可以在前面加個(gè)#就會(huì)自動(dòng)轉(zhuǎn)為相應(yīng)的鏈接,直接上個(gè)例子就都明白了:/** * \攜毀輪brief Obtain current list of path * * \param paths a pointer to an array of strings * \param count indicating the count of path. * * \note * This function will allocate memory for path array. So caller must free the array, but should not free each item. * * \return #API_RESULT_CODE indicating whether this call success or failed. * * \par Sample code: * \code * char **path = NULL; * int count = 0; * test_get_paths(&path, &count); * // use the path * free(path); * path = NULL; * \endcode */ int test_get_paths(char ***paths, int *count);配置Doxygen Doxygen需要一個(gè)配置文件來告訴Doxygen一些選項(xiàng).配置文件就是一個(gè)純文本文件,格式跟標(biāo)準(zhǔn)的Linux配置文件一樣:一行一個(gè)配置項(xiàng),前面是配置項(xiàng)的名字,然后是等號(hào)后面辯信就是配置項(xiàng)的值了.以#開頭都是注釋.Doxygen的選項(xiàng)特別的多,不可以手動(dòng)的去寫,通常都是編輯一個(gè)現(xiàn)有的模板,這個(gè)模板可以用Doxygen來生成:
doxygen -g config-filename
PROJECT_NAME 項(xiàng)目的名字,一定要改成你項(xiàng)目的名字PROJECT_NUMBER 編號(hào),通常使用項(xiàng)目的版本號(hào)OUTPUT_DIRECTORY 文檔輸出存放目錄,建議修改,比如docPROJECT_BRIEF 項(xiàng)目的描述,會(huì)出現(xiàn)文檔每一頁的上面,控制在一行80字符內(nèi)(越短越好)EXTRACT_*** 打頭的選項(xiàng)要仔細(xì)讀,如果是API文檔,則這些全都要設(shè)成NO,這樣就僅抽取特定文檔塊內(nèi)的內(nèi)容. 其他的選項(xiàng)都可以不改,用默認(rèn)的就成.
生成文檔 這步最簡(jiǎn)單,如果前面都就緒了,僅需要運(yùn)行命令即可:
doxygen config-filename
后,文檔就會(huì)出現(xiàn)在所指定的輸出目錄中.
doxygen會(huì)打印出日志信息.為了保證質(zhì)量,更好把把的Warning都修正掉.(這跟修正代碼的所有編譯警告一個(gè)道理).上面例子生成的文檔:int test_get_paths(charpaths, int * count ) Obtain current list of path. Parameters:pathsa pointer to an array of stringscountindicating the count of path.Note:This function will allocate memory for path array. So caller must free the array, but should not free each item.Returns:API_RESULT_CODE indicating whether this call success or failed.Sample code:char **path = NULL; int count = 0; test_get_paths(&path, &count); // use the path free(path); path = NULL; 完整示例下載
幫我推薦一本書，有關(guān)FLASH游戲制作的或c++游戲制作的書.謝謝！我是菜鳥??！
Game Developer Magazine年，共7年的游戲開發(fā)者雜志電子版（含源碼）
Graphics Programming Black Book (by Michael Abrash).zip，圖形編程黑書，Id software的Michael Abrash編著
Game Programming Gems I.rar ，游液羨戲編程精滑前粹I、II（含源碼）
Game Programming Gems II.rar
Graphics Gems I.rar ，圖形學(xué)精粹I、II、III、IV、V
Graphics Gems II.rar
Graphics Gems III IBM.rar
Graphics Gems IV IBM.rar
Graphics Gems V.rar
Computer Graphics, C Version (2nd Ed.).rar ，計(jì)算機(jī)圖形學(xué)C版（第二版）
half_life2_engine.zip ，半條命2游戲引擎源代碼
D3DTutorial10_Half-Life2_Shading.pdf ，半條命2游戲引擎光照分析
Course.PTR.3D.Game.Engine.Programming.eBook-LinG.rar ，3D游戲引擎編程
3D Game Engine Design.rar ，3D游戲引擎設(shè)計(jì)
3D Game Engine Design source code.rar ，3D游戲引擎設(shè)計(jì)源代碼
3D.Game.Programming.All.In.One.zip ，3D游戲編程大全
Game Design – Theory and Practice.rar ，游戲設(shè)計(jì) – 理論與鬧讓拍實(shí)踐
game.programming.all.in.one.zip ，游戲編程大全
The Cg Tutorial – The Definitive Guide to Programmable Real-Time Graphics.rar ，CG指導(dǎo) – 可編程實(shí)時(shí)圖形權(quán)威指南
Tricks Of The 3D Game Programming Gurus – Advanced 3D Graphics And Rasterization.rar ，3D游戲編程大師技巧 – 高級(jí)3D圖形和光柵化
Ultimate Game Design Building Game Worlds.rar ，終極游戲設(shè)計(jì) – 創(chuàng)建游戲世界
Core.Techniques.And.Algorithms.In.Game.Programming.rar ，核心技術(shù)和算法在游戲編程
Simulating Humans.rar ，仿真人類
3D Lighting – History, Concepts, and Techniques.rar ，3D光照 – 歷史，概念和技術(shù)
Lighting.Techniques.For.Real-Time.3D.Rendering.rar ，光照技術(shù)For實(shí)時(shí)3D渲染
Vector.Game.Math.Processors.zip ，向量游戲數(shù)學(xué)處理器
AI for Computer Games and Animation – A Cognitive Modeling Approach.rar ，AI（人工智能）for計(jì)算機(jī)游戲和動(dòng)畫 – 一個(gè)認(rèn)知建模方案
AI.Game.Development.Synthetic.Creatures.With.Learning.And.Reactive.Behaviors.rar ，AI游戲開發(fā) – 合成生物With學(xué)習(xí)和反應(yīng)舉止
AI.Techniques.for.Game.Programming.rar ，AI技術(shù)for游戲編程（含源碼）
Ai.Game.Programming.Wisdom.rar ，AI游戲編程（代碼）
Real_Time_Rendering.rar ，實(shí)時(shí)渲染
special.effects.game.programming.rar ，特效（特殊效果）游戲編程（含源碼）
Shaders.for.Game.Programmers.and.Artists.zip ，著色器for游戲開發(fā)者和藝術(shù)家
Real-Time Shader Programming.rar ，實(shí)時(shí)著色器編程
Wordware.Publishing.Advanced.Lighting.and.Materials.With.Shaders.rar ，高級(jí)光照和材質(zhì)with著色器
OReilly – Physics for Game Developers.rar ，物理for游戲開發(fā)者
GPU Programming Guide.rar ，GPU編程指南
Collision.Detection.pdf.rar ，碰撞檢測(cè)
Collision.Detection.-.Algorithms.and.Applications.rar ，碰撞檢測(cè) – 算法與應(yīng)用
focus.on.3D.terrain.zip ，游戲3D地形編程
Focus.On.3D.Models.zip ，游戲3D模型編程
Focus.On.2D.in.Direct3D.-.fly.pdf ，集中于Direct3D中的2D
Beginning.Game.Audio.Programming.rar ，開始游戲音頻編程（含源碼）
Internetworked.3D.Computer.Graphics.rar ，互連網(wǎng)間的3D計(jì)算機(jī)圖形學(xué)
Beginning.Math.and.Physics.For.Game.Programmers.zip ，開始數(shù)學(xué)和物理for游戲編程者（PDF版）
Beginning Math and Physics for Game Programmers.rar ，開始數(shù)學(xué)和物理for游戲編程者（CHM版）
3D.Math.Primer.for.graphics.and.game.development.zip ，3D數(shù)學(xué)初步for圖形和游戲開發(fā)
The art of computer game design.rar ，計(jì)算機(jī)游戲設(shè)計(jì)藝術(shù)
Sams.Beginning.3D.Game.Programming.eBook-LiB.rar ，3D游戲編程入門
MIT.Press.Rules.of.Play.Game.Design.Fundamentals.rar ，游戲設(shè)計(jì)基礎(chǔ)
design a pc game engine.rar ，設(shè)計(jì)一個(gè)PC游戲引擎
Advanced Graphics Programming Techniques Using Opengl.rar ，高級(jí)圖形編程技術(shù)用OpenGL
Real-time.Rendering.Tricks.and.Techniques.in.DirectX.rar ，DirectX實(shí)時(shí)渲染技巧與技術(shù)
Real-Time Rendering Tricks and Techniques in DirectX(src).ZIP ，DirectX實(shí)時(shí)渲染技巧與技術(shù)（源代碼）
Real Time 3D Terrain Engines Using C++ And Dx9.rar ，實(shí)時(shí)3D地形引擎用C++和Dx9
MS.Press.-.Microsoft.DirectX.9.Programmable.Graphics.Pipeline.rar ，Microsoft DirectX9可編程圖形管線
Wordware.Publishing.OpenGL.Game.Development.eBook-YYePG.rar ，OpenGL游戲開發(fā)
Beginning.OpenGL.Game.Programming.ebook.zip ，OpenGL游戲編程入門
OpenGL.Programming.Guide.rar ，OpenGL編程指南
Addison.Wesley.-.OpenGL.Programming.Guide.2nd.Edition.rar ，OpenGL編程指南（第二版）
Addison-Wesley,.OpenGL.Shading.Language.(2023).DDU.ShareConnector.rar ，OpenGL著色語言（2023）
Learn Vertex and Pixel Shader Programming With Directx 9.rar ，學(xué)習(xí)頂點(diǎn)和像素著色器編程用DirectX9
Shaderx2 – Shader Programming Tips & Tricks With Directx 9.rar ，Shaderx2 – 著色器編程提示與技巧With DirectX9
ShaderX2 Introductions and Tutorials with DirectX9.rar ，ShaderX2介紹和指導(dǎo)With DirectX9
Direct3D.ShaderX.-.Vertex.and.Pixel.Shader.Tips.and.Tricks.rar ，Direct3D.ShaderX – 頂點(diǎn)和像素著色器提示和技巧
Advanced 3D Game Programming with DirectX 9.rar ，高級(jí)3D游戲編程用DirectX 9.0（含源碼，CHM版）
Advanced 3D Game Programming with DirectX 9.rar ，高級(jí)3D游戲編程用DirectX 9.0（PDF版）
DirectX 3D Graphics Programming Bible.rar ，DirectX 3D圖形編程寶典
Introduction to 3D Game Programming with DirectX 9.0.rar ，介紹對(duì)3D游戲編程用DirectX9.0（含部分源代碼）
Beginning.Direct3D.Game.Programming.rar ，Direct3D游戲編程入門
Beginning.DirectX9.zip ，DirectX9入門
Cutting Edge Direct 3D Programming.rar ，Cutting Edge（刀刃）Direct 3D編程
Game.Scripting.Mastery.zip ，游戲描述語言掌握
Data.Structures.for.Game.Programmers.rar ，數(shù)據(jù)結(jié)構(gòu)for游戲編程者（含源碼）
2_OpenGL.Extensions.-.Nvidia.rar ，OpenGL擴(kuò)展（Nvidia）
Managed.DX.9.Kick.Start.Graphics.And.Game.Programming.rar ，DirectX9圖形和游戲編程
OpenGL.Reference.Manual.rar ，OpenGL參考手冊(cè)
OpenGL.Super.Bible.rar ，OpenGL超級(jí)寶典
Tricks of the Windows Game Programming Gurus.rar ，Windows游戲編程大師技巧
Tricks of Win Game Programming Gurus 2ed.rar ，Windows游戲編程大師技巧(第二版)
Game.Programming.Beginners.Guide.rar ，游戲編程初學(xué)者指南
Chris_Crawford_on_Game_Design.rar ，Chris Crawford寫的游戲設(shè)計(jì)書
Advanced.Animation.with.DirectX.rar ，高級(jí)動(dòng)畫with DirectX（含源碼）
Inside Direct3D.rar ，深入Direct3D
Direct3D_9_Basics.rar ，Direct3D 9基礎(chǔ)
Sams Teach Yourself DirectX 7 in 24 Hours.rar ，教你自己DirectX7在24小時(shí)
Programming.Role.Playing.Games.with.DirectX.rar ，用DirectX編程RPG游戲（含源碼）
Programming Multiplayer Games.rar ，編程多玩家游戲
Net Game Programming With Directx 9.0.rar ，網(wǎng)絡(luò)游戲編程with Directx 9.0
Programming Linux Games.rar ，編程Linux游戲
Developing Online Games – An Insiders Guide.rar ，開發(fā)在線游戲 – 一個(gè)權(quán)威人士的指導(dǎo)
Game Coding Complete.rar ，游戲編碼完全
Strategy Game Programming with DirectX 9.0.rar ，策略游戲編程用DirectX9.0
Strategy Game Programming with DirectX 9.0 Source Code.zip ，策略游戲編程用DirectX9.0（源代碼）
Addison-Wesley – Software Engineering and Computer Games.rar ，軟件工程和計(jì)算機(jī)游戲
Artificial Intelligence and Software Engineering.rar ，AI和軟件工程
Game-Programming-OpenGL-C++.rar ，有關(guān)OpenGl和C++的一些資料
GBA Programming Game Boy Advance The Unofficial Guide.rar ，GBA編程非官方指南
Palm.OS.Game.Programming.zip ，Palm掌上操作系統(tǒng)游戲編程
Mac.Game.Programming.pdf ，蘋果機(jī)游戲編程
Premier.Press.J2ME.Game.Programming.rar ，J2ME游戲編程
J2ME Game Development with MIDP2.rar ，J2ME游戲開發(fā)with MIDP2
PHP.Game.Programming.zip ，PHP語言游戲編程
Game.Programming.with.Python.Lua.And.Ruby.zip ，游戲編程用Python,Lua和Ruby語言
Apress.dot.NET.Game.Programming.with.DirectX.9.0.eBook-KB.rar ，點(diǎn)NET游戲編程用DirectX9
Wordware.Wireless.Game.Development.In.C.Cpp.With.BREW.chm ，無線游戲開發(fā)用C、C++ With BREW
DirectX9 User Interfaces Design and Implementation.rar ，DirectX9用戶接口設(shè)計(jì)和實(shí)現(xiàn)
Game.Interface.Design.rar ，游戲接口設(shè)計(jì)
SAMS Teach Yourself Game Programming in 24 Hours.rar ，教你自己游戲編程在24小時(shí)
C.Game.Programming.For.Dummies.2.rar ，C游戲編程傻瓜書2
Beginners Guide to DarkBASIC Game Programming.rar ，初學(xué)者指南對(duì)DarkBASIC游戲編程
Windows Graphics Programming Win32 GDI and DirectDraw.rar ，Windows圖形編程 – Win32 GDI 和 DirectDraw
Game Programming Genesis.rar ，游戲編程起步
2D.Artwork.and.3D.Modeling.for.Game.Artists.zip ，2D藝術(shù)品和3D建模for游戲藝術(shù)家
Game.Art.for.Teens.pdf ，游戲藝術(shù)for青年人
Game Development and Production.rar ，游戲開發(fā)和產(chǎn)品
Game.Developers.Market.Guide.rar ，游戲開發(fā)者市場(chǎng)指南
MIT.Press.A.History.Of.Modern.Computing.eBook-LiB.rar ，現(xiàn)代計(jì)算歷史
The C++ Programming Language NO.3 Edition.rar ，C++編程語言（第三版）
Computer Systems A Programmers Perspective.rar ，計(jì)算機(jī)系統(tǒng) – 一個(gè)編程者的透視
Intel Architecture Software Developer Manual.zip ，Intel架構(gòu)軟件開發(fā)者手冊(cè)
Intel Itanium Assembly Language Reference.rar ，Intel Itanium架構(gòu)匯編語言參考
Agile Software Development.rar ，靈活的軟件開發(fā)
Code Reading The Open Source Perspective.rar ，代碼閱讀與開放源透視
ps2DevEnvironment.exe ，PS2開發(fā)環(huán)境
doxygen-1.3.9.1-setup.exe ，一種文檔自動(dòng)生成軟件
wolf_source.exe ，wolf游戲（id software）源代碼
doom_src.zip ，doom游戲（id software）源代碼
q2src320.exe ，Quake2游戲（id software）源代碼
Q3A_TA_GameSource_127.exe ，QuakeIII（id software）游戲源代碼
關(guān)于doxygen 下載 linux的介紹到此就結(jié)束了，不知道你從中找到你需要的信息了嗎 ？如果你還想了解更多這方面的信息，記得收藏關(guān)注本站。
成都創(chuàng)新互聯(lián)建站主營：成都網(wǎng)站建設(shè)、網(wǎng)站維護(hù)、網(wǎng)站改版的網(wǎng)站建設(shè)公司，提供成都網(wǎng)站制作、成都網(wǎng)站建設(shè)、成都網(wǎng)站推廣、成都網(wǎng)站優(yōu)化seo、響應(yīng)式移動(dòng)網(wǎng)站開發(fā)制作等網(wǎng)站服務(wù)。
分享標(biāo)題：Linux環(huán)境下的Doxygen下載與安裝(doxygen下載linux)
文章源于：http://m.fisionsoft.com.cn/article/dhoojeh.html
