Torna indietro   Hardware Upgrade Forum > Software > Programmazione > Corsi, Tutorial e FAQ

Apple MacBook Air M3: chi deve davvero comprarlo? La recensione
Apple MacBook Air M3: chi deve davvero comprarlo? La recensione
A distanza di circa 8 mesi arriva l’importante aggiornamento dei MacBook Air: nessun cambiamento estetico, ma una revisione hardware interna con l’upgrade al processore M3. Le prestazioni migliorano rispetto alle generazioni precedenti, e questo fa sorgere una domanda spontanea: a chi è rivolto oggi questo laptop? Cerchiamo di capirlo nella nostra recensione 
ASUS ROG Swift OLED PG49WCD: quando QD-OLED e ultrawide si fondono
ASUS ROG Swift OLED PG49WCD: quando QD-OLED e ultrawide si fondono
Da ASUS un monitor particolare ma molto completo: principalmente indirizzato al videogiocatore, può essere sfruttato con efficacia anche per attività creative e di produzione multimediale
Dreame L10s Pro Ultra Heat: la pulizia di casa tutta sostanza
Dreame L10s Pro Ultra Heat: la pulizia di casa tutta sostanza
Il nuovo robot aspirapolvere domestico di Dreame abbina funzionalità complete a un moccio flottante che raggiunge al meglio gli angoli delle pareti. Un prodotto tutto in uno semplice da utilizzare ma molto efficace, in grado di rispondere al meglio alle necessità di pulizia della casa
Tutti gli articoli Tutte le news

Vai al Forum
Rispondi
 
Strumenti
Old 24-12-2003, 11:10   #1
Luc@s
Senior Member
 
L'Avatar di Luc@s
 
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
[Tutorial] Doxygen

Doxygen Tutorial
Doxygen è un software open source utilissimo(1) che permette di documentare un software scritto in Java/C/C++.
Si compone di 2 files doxygen.exe e doxytag.exe che possono essere messi ove si vuole ma per chiamarli
senza dover inserire sempre il percorso bisogna inserirli nel PATH.
Per spiegare il funzionamento di questo tool prendiamo un codice di esempio:

Codice:
#include <iostream>

/// il namespace std
using namespace std;

/// Classe Generica
class Prova
{
	public:
		///Costruttore
		Prova(){ };
		///Distruttore
		~Prova(){ };
		/// Funz che saluta
		inline char * saluta(char * nm){ return nm; };
	private:
};

int main()
{
	return 0;
}
Doxygen accetta come parametro(obligatorio) il file di configurazione, che può essere chiamato a proprio
piacimento.
Quote:
doxygen <config-file>
Noi per comodità lo chiameremo doxy.conf.
Il files sarà cosi composto:

Quote:
; Il nome del progetto
PROJECT_NAME = "Prova"
;La lingua
OUTPUT_LANGUAGE = "Italian"
; La directory ove porre la documentazione
OUTPUT_DIRECTORY = "doc"
; # I Seguenti valori accettano YES o NO #
; Genera la documentazione HTML
GENERATE_HTML = YES
; Permette la navigazione tra i files
SOURCE_BROWSER = YES
; Disabilità la creazione della documentazione in formato LATEX
GENERATE_LATEX = NO
; Legge le sotto-directory ricorsivamente
RECURSIVE = YES
; Permette l' espansione delle macro
MACRO_EXPANSION = YES
Salviamo il files di configurazione nella directory principale del programma
Il risultato dell' operazione e visibile nel mio sito(2).
Dopo questa introduzione possiamo passare ad opzioni più avanzate.
Aggiungeremo ora al nostro doxy.conf le seguenti opzioni e proveremo a vedere il risultato:

Quote:
; # I Seguenti valori accettano YES o NO #
; Opzione disponibile per soli programmi in C
OPTIMIZE_OUTPUT_FOR_C = NO
; Opzione disponibile per soli programmi in Java
OPTIMIZE_OUTPUT_JAVA = NO
; Mostra il tag [inline] difianco ai membri di classe che lo sono
INLINE_INFO = YES
; Valuta le espressioni macro presenti nel progetto
ENABLE_PREPROCESSING = YES
; Se attivo Doxygen mostra le relazioni tra i template e le sue istanze
TEMPLATE_RELATIONS = YES
; Permette la ricerca ma sul server deve essere presente PHP versione 4.1.0 o successive
SEARCHENGINE = NO
Detto questo ora possiamo dire che d'ora in poi i nostri programmi e librerie potranno essere
documentati senza problemi



Luc@s

(1) http://www.stack.nl/~dimitri/doxygen...html#latestsrc
(2) allegato
Allegati
File Type: rar doc.rar (9.7 KB, 104 visite)
__________________
Gnu/Linux User
Luc@s è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 10:08   #2
Luc@s
Senior Member
 
L'Avatar di Luc@s
 
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
Piccolo consiglio, lasciate la lingua di default perche la traduzione di ora nn mi sembra il maximo.


Ciao e aspetto feedback
__________________
Gnu/Linux User
Luc@s è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 11:29   #3
VICIUS
Senior Member
 
L'Avatar di VICIUS
 
Iscritto dal: Oct 2001
Messaggi: 11471
Non ho esperienza con doxy ma con javadoc ogni tanto ci lavoravo. Mi chiedevo se anche in doxy fosse possibile usare qui tag come @autor, @version, @param, @return...

tutti i commenti /// vengono messi nel file HTML vero ? perchè nel tutorial non se ne parla.

ciao
VICIUS è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 11:32   #4
Luc@s
Senior Member
 
L'Avatar di Luc@s
 
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
Quote:
Originariamente inviato da VICIUS
Non ho esperienza con doxy ma con javadoc ogni tanto ci lavoravo. Mi chiedevo se anche in doxy fosse possibile usare qui tag come @autor, @version, @param, @return...

tutti i commenti /// vengono messi nel file HTML vero ? perchè nel tutorial non se ne parla.

ciao
Con l' opt OPTIMIZE_OUTPUT_JAVA = YES si puo
Cmq per l' html si puo usare /// per il C++/Java
/** */ x il C.

Ti è sembrato completo com tutorial?
__________________
Gnu/Linux User
Luc@s è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 11:36   #5
VICIUS
Senior Member
 
L'Avatar di VICIUS
 
Iscritto dal: Oct 2001
Messaggi: 11471
A parte i dubbi che che mi erano venuti prima . si l'ho trovato un buon tutorial per un niubbo visto che sono riuscito a fare qualcosa pure io

ciao
VICIUS è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 11:45   #6
Luc@s
Senior Member
 
L'Avatar di Luc@s
 
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
Quote:
Originariamente inviato da VICIUS
A parte i dubbi che che mi erano venuti prima . si l'ho trovato un buon tutorial per un niubbo visto che sono riuscito a fare qualcosa pure io

ciao
Cosa è uscito???
Posso vedere?
__________________
Gnu/Linux User
Luc@s è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 12:23   #7
VICIUS
Senior Member
 
L'Avatar di VICIUS
 
Iscritto dal: Oct 2001
Messaggi: 11471
una classe appena accennata. http://pigaz.altervista.org/doxy-test.tar.bz2

ciao
VICIUS è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 12:27   #8
Luc@s
Senior Member
 
L'Avatar di Luc@s
 
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
cmq la trad italiana nn è il massimo, vero?
__________________
Gnu/Linux User
Luc@s è offline   Rispondi citando il messaggio o parte di esso
Old 27-12-2003, 12:43   #9
VICIUS
Senior Member
 
L'Avatar di VICIUS
 
Iscritto dal: Oct 2001
Messaggi: 11471
Quote:
Originariamente inviato da Luc@s
cmq la trad italiana nn è il massimo, vero?
a parte le ripetizioni, e alcuni doppi sensi sui membri...

ciao
VICIUS è offline   Rispondi citando il messaggio o parte di esso
Old 28-12-2003, 18:53   #10
Luc@s
Senior Member
 
L'Avatar di Luc@s
 
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
me lo puoi testare per il java????


Tnk
__________________
Gnu/Linux User
Luc@s è offline   Rispondi citando il messaggio o parte di esso
Old 28-12-2003, 19:20   #11
VICIUS
Senior Member
 
L'Avatar di VICIUS
 
Iscritto dal: Oct 2001
Messaggi: 11471
certo qui c'è l'output di un piccolo esercizio fatto in java che feci qualche tempo fa. http://pigaz.altervista.org/doxy-java.tar.bz2. è piuveloce di javadoc e la documentazione tiene di meno pero il riusultato è un po "incasinato" e non è completo. secondo me si puo ancora migliorare.

ciao
VICIUS è offline   Rispondi citando il messaggio o parte di esso
Old 28-12-2003, 19:40   #12
Luc@s
Senior Member
 
L'Avatar di Luc@s
 
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
meglio di fare tutto a mano.
Cmq e opensource quindi sempre aggiornato
__________________
Gnu/Linux User
Luc@s è offline   Rispondi citando il messaggio o parte di esso
Old 20-07-2005, 12:21   #13
gotam
Senior Member
 
L'Avatar di gotam
 
Iscritto dal: Aug 2000
Città: Formia
Messaggi: 6846
Azzzz ottimo doxygen
__________________
"La birra è la prova che dio ci ama e vuole che siamo felici"
gotam è offline   Rispondi citando il messaggio o parte di esso
Old 19-05-2006, 09:42   #14
Sirbako
Senior Member
 
L'Avatar di Sirbako
 
Iscritto dal: Oct 2004
Città: Rovereto (tn)
Messaggi: 2187
un conisglio per il tutorial:
dovresti aggiungere una breve spiegazione su come inserirei i commenti, se c sono caratteri speciali per avere autore ecc..
ciao
__________________

Esse.Ti.?!?
Sirbako è offline   Rispondi citando il messaggio o parte di esso
Old 15-06-2009, 13:53   #15
cgiocoli
Junior Member
 
L'Avatar di cgiocoli
 
Iscritto dal: Feb 2006
Città: Padova
Messaggi: 13
info-caratteri e colori

Ciao ragazzi,
è un po' che sto bazzicando con il C++ e la creazione della documentazione
con doxygen. Sapete come si possono implementare i caratteri e i colori, per sembio bold e rosso?

grazie mille
__________________
---
The time is gone the song is over, thought I'd something more to say!
cgiocoli
cgiocoli è offline   Rispondi citando il messaggio o parte di esso
Old 16-12-2011, 15:54   #16
Old Siam Sir
Member
 
Iscritto dal: Oct 2007
Messaggi: 38
Ciao a tutti, sto provando a usare doxygen, ho scaricato l'ultima versione, con Doxywizard che funge da interfaccia grafica e vorrei usarlo per creare della documentazione dai commenti che ho inserito nel codice... solo che non riesco a capire come devono essrere formattati i commenti visto che il VHDL non usa "/*", "//*" o "///" ma definisce i commenti come frasi precedute da "--".
Qualcuno è in grado di aiutarmi?
Grazie mille anticipatamente a tutti!
Old Siam Sir è offline   Rispondi citando il messaggio o parte di esso
Old 03-04-2012, 12:36   #17
Blackskull182
Member
 
L'Avatar di Blackskull182
 
Iscritto dal: Mar 2007
Messaggi: 207
Grazie!
__________________
Tutti gli imbecilli della Borghesia che pronunciano continuamente le parole: immorale, immoralità, moralità nell’arte e altre bestialità mi fanno pensare a Louise Villedieu, puttana da cinque franchi, che accompagnandomi una volta al Louvre, dove non era mai stata, si mise ad arrossire, a coprirsi la faccia, e tirandomi a ogni momento per la manica, mi domandava davanti alle statue e ai quadri immortali come si potesse esporre pubblicamente simili indecenze. (Charles Baudelaire)
Blackskull182 è offline   Rispondi citando il messaggio o parte di esso
 Rispondi


Apple MacBook Air M3: chi deve davvero comprarlo? La recensione Apple MacBook Air M3: chi deve davvero comprarlo...
ASUS ROG Swift OLED PG49WCD: quando QD-OLED e ultrawide si fondono ASUS ROG Swift OLED PG49WCD: quando QD-OLED e ul...
Dreame L10s Pro Ultra Heat: la pulizia di casa tutta sostanza Dreame L10s Pro Ultra Heat: la pulizia di casa t...
HONOR Magic6 Pro: come funziona Magic Portal, il modo ''intelligente'' di condividere HONOR Magic6 Pro: come funziona Magic Portal, il...
L'innovazione richiede fiducia: Workday si propone come guida nell'era dell'IA L'innovazione richiede fiducia: Workday si propo...
RocketStar FireStar Drive: un propulsore...
Roscosmos: il lancio del razzo spaziale ...
Italia strategica per Oracle. Arriva la ...
Sam-Bankman Fried: 25 anni di reclusione...
Mobility Analytics di WINDTRE Business p...
Il lander lunare JAXA SLIM si è r...
Warframe conquista l'iPhone: senza soluz...
Marvel Rivals!, l'inaspettato shooter Pv...
Twitch aggiorna le linee guida sui conte...
Galaxy M55 ufficiale: la nuova fascia me...
Google corregge sette vulnerabilit&agrav...
IA: le imprese italiane sono in prima li...
Garmin Dash Cam 57: un'alleata perfetta ...
Elgato Facecam MK2: come rendere ancora ...
2 iRobot Roomba al prezzo più sco...
Chromium
GPU-Z
OCCT
LibreOffice Portable
Opera One Portable
Opera One 106
CCleaner Portable
CCleaner Standard
Cpu-Z
Driver NVIDIA GeForce 546.65 WHQL
SmartFTP
Trillian
Google Chrome Portable
Google Chrome 120
VirtualBox
Tutti gli articoli Tutte le news Tutti i download

Strumenti

Regole
Non Puoi aprire nuove discussioni
Non Puoi rispondere ai messaggi
Non Puoi allegare file
Non Puoi modificare i tuoi messaggi

Il codice vB è On
Le Faccine sono On
Il codice [IMG] è On
Il codice HTML è Off
Vai al Forum


Tutti gli orari sono GMT +1. Ora sono le: 23:05.


Powered by vBulletin® Version 3.6.4
Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
Served by www1v