Doxygen เป็นเครื่องมือปกติโดยพฤตินัยสำหรับสร้างเอกสารจากแหล่ง C ++ ที่มีหมายเหตุประกอบ อย่างไรก็ตาม ยังสนับสนุนภาษาโปรแกรมที่รู้จักกันดีต่างๆ เช่น C, Object-C, C#, Hypertext Preprocessor, Java, Python, IDL (Corba, Microsoft และ UNO/ รสชาติของ OpenOffice), Fortran, VHDL และ Tcl บทความนี้อธิบายเกี่ยวกับ-“วิธีการติดตั้ง Doxygen บน Ubuntu”
ในการติดตั้ง 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 https://in.archive.ubuntu.com/ubuntu xenial/main amd64 libllvm3.6v5 amd64 1:3.6.2-3ubuntu2 [8,075 kB] Get:2 https://in.archive.ubuntu.com/ubuntu xenial-updates/main amd64 libobjc4 amd64 5.4.0-6ubuntu1~16.04.4 [111 kB] Get:3 https://in.archive.ubuntu.com/ubuntu xenial-updates/main amd64 libobjc-5-dev amd64 5.4.0-6ubuntu1~16.04.4 [380 kB] Get:4 https://in.archive.ubuntu.com/ubuntu xenial/main amd64 libclang1-3.6 amd64 1:3.6.2-3ubuntu2 [3,696 kB] Get:5 https://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
ผลลัพธ์ตัวอย่างควรเป็นแบบนี้ –
หลังจากบทความนี้ คุณจะสามารถเข้าใจ – วิธีการติดตั้ง Doxygen บน Ubuntu ในบทความหน้า เราจะมากับเคล็ดลับและเคล็ดลับบน Linux เพิ่มเติม อ่านต่อ!
