資料結構
網路
RDBMS
作業系統
Java
MS Excel
iOS
HTML
CSS
Android
Python
C 程式設計
C++
C#
MongoDB
MySQL
Javascript
PHP
物理學
化學
生物學
數學
英語
經濟學
心理學
社會學
時尚學
法律學如何在 Ubuntu 上安裝 Doxygen
Doxygen 是從帶註釋的 C++ 原始碼生成文件的實際標準工具，但是，它也支援其他著名的程式語言，如 C、Objective-C、C#、超文字預處理器、Java、Python、IDL（Corba、Microsoft 和 UNO/OpenOffice 版本）、Fortran、VHDL 和 Tcl。本文解釋了“如何在 Ubuntu 上安裝 Doxygen”
要安裝 Doxygen，請使用以下命令 –
$ sudo apt-get install doxygen
示例輸出應如下所示 –
Reading package lists... Done Building dependency tree Reading state information... Done The following packages were automatically installed and are no longer required: libterm-readkey-perl linux-headers-4.4.0-31 linux-headers-4.4.0-31-generic linux-image-4.4.0-31-generic linux-image-extra-4.4.0-31-generic linux-signed-image-4.4.0-31-generic Use 'sudo apt autoremove' to remove them. The following additional packages will be installed: libclang1-3.6 libllvm3.6v5 libobjc-5-dev libobjc4 Suggested packages: doxygen-latex doxygen-doc doxygen-gui graphviz The following NEW packages will be installed: doxygen libclang1-3.6 libllvm3.6v5 libobjc-5-dev libobjc4 0 upgraded, 5 newly installed, 0 to remove and 26 not upgraded. Need to get 15.9 MB of archives. After this operation, 64.0 MB of additional disk space will be used. Do you want to continue? [Y/n] y Get:1 http://in.archive.ubuntu.com/ubuntu xenial/main amd64 libllvm3.6v5 amd64 1:3.6.2-3ubuntu2 [8,075 kB] Get:2 http://in.archive.ubuntu.com/ubuntu xenial-updates/main amd64 libobjc4 amd64 5.4.0-6ubuntu1~16.04.4 [111 kB] Get:3 http://in.archive.ubuntu.com/ubuntu xenial-updates/main amd64 libobjc-5-dev amd64 5.4.0-6ubuntu1~16.04.4 [380 kB] Get:4 http://in.archive.ubuntu.com/ubuntu xenial/main amd64 libclang1-3.6 amd64 1:3.6.2-3ubuntu2 [3,696 kB] Get:5 http://in.archive.ubuntu.com/ubuntu xenial/main amd64 doxygen amd64 1.8.11-1 [3,679 kB] .........................................................................................
要獲取有關 Doxygen 的更多資訊，請使用以下命令 –
$ doxygen --help
示例輸出應如下所示-
Doxygen version 1.8.11 Copyright Dimitri van Heesch 1997-2015 You can use doxygen in a number of ways: 1) Use doxygen to generate a template configuration file: doxygen [-s] -g [configName] If - is used for configName doxygen will write to standard output. 2) Use doxygen to update an old configuration file: doxygen [-s] -u [configName] 3) Use doxygen to generate documentation using an existing configuration file: doxygen [configName] If - is used for configName doxygen will read from standard input. 4) Use doxygen to generate a template file controlling the layout of the generated documentation: doxygen -l [layoutFileName.xml] 5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex. RTF: doxygen -w rtf styleSheetFile HTML: doxygen -w html headerFile footerFile styleSheetFile [configFile] LaTeX: doxygen -w latex headerFile footerFile styleSheetFile [configFile] 6) Use doxygen to generate a rtf extensions file RTF: doxygen -e rtf extensionsFile ........................................................................
若要生成原始碼，請使用以下程式碼-
$ doxygen -g sample_text.conf
在上一個命令中，它生成了一個名為 sample_text.conf 的檔案，其中包含以下所示程式碼 –
# Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- ..................................................................................
要生成文件，請使用以下命令 –
$ doxygen sample_text.conf
示例輸出應如下所示 –
Searching for include files... Searching for example files... Searching for images... Searching for dot files... Searching for msc files... Searching for dia files... Searching for files to exclude Searching INPUT for files to process... Searching for files in directory /home/linux warning: source /home/linux/.dbus is not a readable file or directory... skipping. Reading and parsing tag files Parsing files Preprocessing /home/linux/abc.txt... Parsing file /home/linux/abc.txt... Preprocessing /home/linux/bbc.txt... Parsing file /home/linux/bbc.txt... Building group list... Building directory list... Building namespace list... Building file list... Building class list... Associating documentation with classes... Computing nesting relations for classes... Building example list... Searching for enumerations... Searching for documented typedefs... Searching for members imported via using declarations... Searching for included using directives... Searching for documented variables... Building interface member list... ................................................................
若要瀏覽 HTML 格式的文件，請使用以下命令 –
$ cd html /html$ google-chrome index.html
示例輸出應如下所示 –
在閱讀本文後，你將能夠理解 – 如何在 Ubuntu 上安裝 Doxygen。在我們的下一篇文章中，我們將提供更多基於 Linux 的技巧和提示。繼續閱讀！
更新於: 2020 年 1 月 20 日
12K+ 瀏覽量
廣告