imported>SchlurcherBot：Bot: http → https

2025-12-13T08:27:43Z

Bot: http → https

新页面

{{roughtranslation|time=2020-02-25T05:28:33+00:00}}
{{Unreferenced|time=2017-10-26T16:40:42+00:00}}
{{noteTA
|G1=IT
|G2=FL
|1=zh-cn:文档生成器; zh-tw:文件產生器;
}}
{{Infobox_Software
| name = Doxygen
| logo = Doxygen.png
| caption =
| screenshot =
| developer = Dimitri van Heesch
| programming_language = [[C++]]
| operating_system = [[跨平台]]
| genre = 文檔生成器
| license = [[GNU通用公共许可证]]
| website = {{URL|https://www.doxygen.nl/}}
}}
'''Doxygen'''是一個适用于[[C++]]、[[C语言|C]]、[[Java]]、[[Objective-C]]、[[Python]]、[[接口描述语言|IDL]]（[[CORBA]]和Microsoft flavors）、[[Fortran]]、[[VHDL]]、[[PHP]]、[[C Sharp|C#]]和[[D語言]]的文檔生成器。它可以在大多數[[類Unix]][[操作系統]]、[[macOS]]以及[[Microsoft Windows]]上執行。初始版本的Doxygen使用了一些舊版本DOC++的源代码，在那之后，Dimitri van Heesch重写了Doxygen的源代码。

Doxygen是一個編寫軟件參考文檔的工具。該文檔是直接寫在源代码中的，因此比較容易保持更新。Doxygen可以交叉引用和源代码，使文件的讀者可以很容易地引用實際的源代码。

[[KDE]]将Doxygen作为它的一部分且[[KDevelop]]具有內置的支持。Doxygen的发布遵守[[GNU通用公共许可证]]，是[[自由软件]]。

==用法==
如同Javadoc，Doxygen從源文件提取註解。除了Javadoc的語法，Doxygen支持[[Qt]]使用的文檔標記，並可以輸出成[[HTML]]、以及[[HTML Help|CHM]]、[[RTF]]、[[PDF]]、[[LaTeX]]、[[PostScript]]或[[手册页]]。

==範例代碼==
[[File:Doxygen ouput.png|thumb|200px|内容输出为HTML的截图]]

注释文档一般用两个星号标志：

<syntaxhighlight lang="cpp">
/**
* <A short one line description>
*
* <Longer description>
* <May span multiple lines or paragraphs as needed>
*
* @param Description of method's or function's input parameter
* @param ...
* @return Description of the return value
*/
</syntaxhighlight>
但也能像{{lang|en|HeaderDoc}}一樣使用'''<nowiki>*!</nowiki>'''的標誌。例如：
<syntaxhighlight lang="cpp">
/*!
* <A short one line description>
*
* <Longer description>
* <May span multiple lines or paragraphs as needed>
*
* @param Description of method's or function's input parameter
* @param ...
* @return Description of the return value
*/
</syntaxhighlight>

以下說明如何从C++源代码產生文档。請確保參數EXTRACT_ALL在Doxyfile設置為YES。

<syntaxhighlight lang="cpp">

/**
* @file
* @author John Doe <jdoe@example.com>
* @version 1.0
*
* @section LICENSE
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option)any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details at
* http://www.gnu.org/copyleft/gpl.html
*
* @section DESCRIPTION
*
* The time class represents a moment of time.
*/

class Time {

public:

/**
* Constructor that sets the time to a given value.
*
* @param timemillis Number of milliseconds
* passed since Jan 1, 1970.
*/
Time (int timemillis){
// the code
}

/**
* Get the current time.
*
* @return A time object set to the current time.
*/
static Time now () {
// the code
}
};
</syntaxhighlight>

另一種方法是首選的一些參數的記錄如下。這將產生同樣的文件。

<syntaxhighlight lang="cpp">
/**
* Constructor that sets the time to a given value.
*
*/
Time（int timemillis ///< Number of milliseconds passed since Jan 1, 1970.
）
{
// the code
}
</syntaxhighlight>

==外部連結==
*{{Official|https://www.doxygen.org/}}
*{{SourceForge|doxygen|Doxygen}}
*{{Freshmeat|doxygen|Doxygen}}
*[http://svn.wikimedia.org/doc/ MediaWiki documentation]{{Wayback|url=http://svn.wikimedia.org/doc/ |date=20090701092943 }} in Doxygen
*[http://harmony.apache.org/subcomponents/drlvm/DoxygenStart.html Example of documentation automatically generated by Doxygen ]{{Wayback|url=http://harmony.apache.org/subcomponents/drlvm/DoxygenStart.html |date=20090908185951 }} for Apache Harmony

[[Category:SourceForge專案]]
[[Category:使用Qt的軟體]]
[[Category:跨平台软件]]
[[Category:自由计算机程序设计工具]]
[[Category:用C++编程的自由软件]]
[[Category:自由文档生成器]]

Doxygen - 版本历史

imported>SchlurcherBot：​Bot: http → https

imported>SchlurcherBot：Bot: http → https