Αλλαγή γραμματοσειράς
Ημερομηνία Δευτ Ιουν 17, 2019 7:47 am
foss.aueb.gr

Προγραμματισμός

Doxygen

Σχετικά με τον προγραμματισμό

Doxygen

Δημοσίευσηαπό c00kiemon5ter » Παρ Σεπ 25, 2009 2:27 pm

Doxygen έγραψε:Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.

1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in LaTeX) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
2. You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
3. You can even `abuse' doxygen for creating normal documentation (as I did for this manual).

Doxygen is developed under Linux and Mac OS X, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.


Output Formats έγραψε:* The following output formats are directly supported by doxygen:
HTML
Generated if GENERATE_HTML is set to YES in the configuration file.

LaTeX
Generated if GENERATE_LATEX is set to YES in the configuration file.

Man pages
Generated if GENERATE_MAN is set to YES in the configuration file.

RTF
Generated if GENERATE_RTF is set to YES in the configuration file.
Note that the RTF output probably only looks nice with Microsoft's Word 97. If you have success with other programs, please let me know.

XML
Generated if GENERATE_XML is set to YES in the configuration file.

Qt Help Project (.qhp)
Generated if GENERATE_QHP is set to YES in the configuration file.

* The following output formats are indirectly supported by doxygen:
Compiled HTML Help (a.k.a. Windows 98 help)
Generated by Microsoft's HTML Help workshop from the HTML output if GENERATE_HTMLHELP is set to YES.

Qt Compressed Help (.qch)
Generated by Qt's qhelpgenerator tool from the HTML output if GENERATE_QHP is set to YES.

PostScript
Generated from the $\mbox{\LaTeX}$ output by running make ps in the output directory. For the best results PDF_HYPERLINKS should be set to NO.

PDF
Generated from the $\mbox{\LaTeX}$ output by running make pdf in the output directory. To improve the PDF output, you typically would want to enable the use of pdflatex by setting USE_PDFLATEX to YES in the configuration file. In order to get hyperlinks in the PDF file you also need to enable PDF_HYPERLINKS.


Μερικά projects που έχουν documentation μέσω Doxygen εδώ
Κι εδώ για το πως περίπου χρησιμοποιείται (λίγο πιο κάτω έχει παράδειγμα κ το αποτέλεσμα).
Έχει πολύ documentation.

Ουσιαστικά μετατρέπει τα comments σε κάτι πιο eye-candy :P
Ωραίο είναι
Computers are simple. You just write an instruction and they follow it.
Εικόνα
a cookie! ~ i.will.do.science.to.it! Εικόνα
Άβαταρ μέλους
c00kiemon5ter
cookie hunter
 
Δημοσ.: 554
Εγγραφη: Δευτ Μάιος 11, 2009 1:55 am
Τοποθεσια: (void *)NULL
Operating System: ~ Arch ~ .: Gentoo :.

Re: Doxygen

Δημοσίευσηαπό Master_ex » Κυρ Σεπ 27, 2009 4:10 pm

Από το λίγο που διάβασα εξάγει ένα documentation αυτής της μορφής από τα σχόλια του κώδικα. Καλή φάση! Με τη πρώτη ευκαιρία πρέπει να το δοκιμάσω :D
Άβαταρ μέλους
Master_ex
Moderator
 
Δημοσ.: 258
Εγγραφη: Παρ Μάιος 08, 2009 12:14 am
Operating System: .:/ arch \:.

Re: Doxygen

Δημοσίευσηαπό Master_ex » Τετ Οκτ 14, 2009 2:03 pm

Λοιπόν, το δοκίμασα ( για java ) και μπορώ να πώ ότι είναι πολύ εύκολο στη χρήση και το αποτέλεσμα είναι πολύ καλό. Βέβαια δεν έχω δοκιμάσει τη δυνατότητα για javadoc που δίνει το NetBeans αλλά κρίνοντας από το documentation της java πιο όμορφο μου φαίνεται αυτό.

Απ'οτι είδα αρχικά μάλλον το ανέπτυξαν για c/c++ και υπάρχουν διάφορες "εντολές" που μπορείς να χρησιμοποήσεις για το documentation του κωδικά σου.
Άβαταρ μέλους
Master_ex
Moderator
 
Δημοσ.: 258
Εγγραφη: Παρ Μάιος 08, 2009 12:14 am
Operating System: .:/ arch \:.

Re: Doxygen

Δημοσίευσηαπό TNT » Τρί Δεκ 22, 2009 10:19 am

Το χρησιμοποιώ με C/C++ και είμαι απόλυτα ικανοποιημένος.
who am i?
Άβαταρ μέλους
TNT
Open Member
 
Δημοσ.: 119
Εγγραφη: Κυρ Δεκ 20, 2009 2:23 pm


Επιστροφή στην Προγραμματισμός

cron
foss.aueb.gr

Μελη σε συνδεση

Συνολικά υπάρχουν 0 μέλη συνδεδεμένα: 0 εγγεγραμμένο, 0 κρυφοί και 0 επισκέπτης (με βάση τα μέλη που έχουν συνδεθεί τα τελευταία 5 λεπτά)
Περισσότερα μέλη σε σύνδεση 167 την Κυρ Οκτ 02, 2016 2:55 am

Μέλη σε αυτή την Δ. Συζήτηση: Δεν υπάρχουν εγγεγραμμένα μέλη και 0 επισκέπτες

Γενέθλια

Κανένα μέλος δεν έχει γενέθλια σήμερα