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

OnePlus Nord 2, un ottimo smartphone migliorato solo dove serviva. La recensione
OnePlus Nord 2, un ottimo smartphone migliorato solo dove serviva. La recensione
OnePlus Nord 2 si è migliorato rispetto al suo predecessore solo in alcune aree cruciali: fra le novità più evidenti infatti processore, fotocamera posteriore e ricarica rapida. E' uno dei midrange più vicini in assoluto a un top di gamma per quanto riguarda l'esperienza d'uso, e ha tutto quello che serve anche all'utente più esigente
ASUS ROG Zephyrus M16 è il notebook gaming dallo schermo molto particolare
ASUS ROG Zephyrus M16 è il notebook gaming dallo schermo molto particolare
L'accoppiata tra CPU Intel Core i9 e GPU NVIDIA GeForce RTX 3070 garantisce prestazioni sempre molto elevate con questo notebook, che ha dalla sua uno chassis robusto e dal peso contenuto viste le dimensioni. Più di tutto però spicca lo schermo da 16 pollici, con una risoluzione elevata e soprattutto un rapporto di 16:10 tra i lati che lo rende unico sul mercato
Elgato Facecam: una webcam per i gamer
Elgato Facecam: una webcam per i gamer
Elgato, azienda specializzata in periferiche per i giocatori e per gli streamer, ha portato a termine i suoi studi su una webcam altamente ottimizzata per gli usi videoludici. Ecco come si comporta
Tutti gli articoli Tutte le news

Vai al Forum
Rispondi
 
Strumenti
Old 24-12-2003, 10: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, 09: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, 10: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, 10: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, 10: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, 10: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, 11: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, 11: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, 11: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, 17: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, 18: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, 18: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, 11:21   #13
gotam
Senior Member
 
L'Avatar di gotam
 
Iscritto dal: Aug 2000
Città: Formia
Messaggi: 6687
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, 08:42   #14
Sirbako
Senior Member
 
L'Avatar di Sirbako
 
Iscritto dal: Oct 2004
Città: Rovereto (tn)
Messaggi: 2184
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, 12: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, 14: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, 11: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


OnePlus Nord 2, un ottimo smartphone migliorato solo dove serviva. La recensione OnePlus Nord 2, un ottimo smartphone migliorato ...
ASUS ROG Zephyrus M16 è il notebook gaming dallo schermo molto particolare ASUS ROG Zephyrus M16 è il notebook gamin...
Elgato Facecam: una webcam per i gamer Elgato Facecam: una webcam per i gamer
vivo X60 Pro: top di gamma tascabile con super fotocamera Zeiss vivo X60 Pro: top di gamma tascabile con super f...
LG OLED EVO TV G1 55 pollici: l'OLED alla massima potenza. La recensione LG OLED EVO TV G1 55 pollici: l'OLED alla massim...
G.Skill Royal Elite DDR4-4000: 32 GB, ti...
Niente volante tradizionale per Tesla Mo...
Più wafer a 10 che a 14 nanometri...
Le immagini del fairing con paracadute d...
NASA InSight ha svelato cosa c'è sotto l...
New World, una patch per "salvare&q...
Green Pass falsi in vendita online a 100...
HONOR Magic 3 avrà un comparto fo...
Apex Legends: Ribalta, la nuova Leggenda...
vivo X60 Pro: la nuova versione della st...
Engie EPS passa nelle mani della taiwane...
Il viaggio dell'unicorno Infobip, da for...
Olimpiadi Tokyo 2020: dove seguirle in T...
Steam Deck: la console portatile pu&ogra...
HiPad Pro di Chuwi: caratteristiche del ...
LibreOffice 7.1.5
Firefox Portable
Firefox 90
Skype
Chromium
Opera Portable
Opera 77
Google Chrome Portable
VirtualBox
Dropbox
7-Zip
K-Lite Mega Codec Pack
K-Lite Codec Pack Full
K-Lite Codec Pack Standard
K-Lite Codec Pack Basic
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: 09:19.


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