Doxygen/it: Revision history

Diff selection: Mark the radio buttons of the revisions to compare and hit enter or the button at the bottom.
Legend: (cur) = difference with latest revision, (prev) = difference with preceding revision, m = minor edit.

(newest | oldest) View ( | ) (20 | 50 | 100 | 250 | 500)

10 August 2023

  • curprev 12:4312:43, 10 August 2023Simone.b talk contribs 44,584 bytes +19 Created page with "Usa sempre le virgolette triple per le docstring e assicurati che seguano immediatamente la dichiarazione della classe o della funzione."
  • curprev 12:4212:42, 10 August 2023Simone.b talk contribs 44,565 bytes +16 Created page with "<div class="mw-collapsible mw-collapsed toccolours"> I seguenti stili di commento non consentiranno l'analisi delle docstring da parte di {{incode|doxypypy}}, quindi dovrebbero essere evitati."
  • curprev 12:4212:42, 10 August 2023Simone.b talk contribs 44,549 bytes +59 Created page with "Per utilizzare la conversione automatica dei blocchi di documentazione è importante che i sorgenti Python originali siano scritti correttamente, seguendo le linee guida Pythonic in [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8] e [https://www.python.org/dev/peps/pep-0257/PEP257]. Un codice scritto in modo approssimativo causerà il fallimento di {{incode|doxypypy}} durante l'elaborazione del file, e quindi Doxygen non sarà in grado di formattare..."
  • curprev 12:4112:41, 10 August 2023Simone.b talk contribs 44,490 bytes +62 Created page with "=== Controllo della qualità del codice Python ==="
  • curprev 12:4112:41, 10 August 2023Simone.b talk contribs 44,428 bytes +32 Created page with "{{Caption|Flusso di lavoro generale per produrre la documentazione del codice sorgente con Doxygen, quando i file Python vengono filtrati per trasformare i blocchi dei commenti.}}"
  • curprev 12:4112:41, 10 August 2023Simone.b talk contribs 44,396 bytes +14 Created page with "Nota che i file Python esistenti che usano già lo stile {{incode|##doppio cancelletto}} per i loro blocchi di commenti non saranno influenzati dal filtro {{incode|doxypypy}} e saranno processati normalmente da Doxygen."
  • curprev 12:4012:40, 10 August 2023Simone.b talk contribs 44,382 bytes +25 No edit summary
  • curprev 12:3512:35, 10 August 2023Simone.b talk contribs 44,357 bytes +58 Created page with "Con questa configurazione impostata, il comando {{incode|doxygen Doxyfile}} può essere eseguito per generare la documentazione come di consueto. Ogni file Python che usa <code><nowiki>'''virgolette triple'''</nowiki></code> Pythonic sarà riformattato al volo per usare i commenti in stile {{incode|##Doxygen}}, e poi saranno elaborati da Doxygen, che ora sarà in grado di interpretare i comandi speciali e la sintassi markdown. Il..."
  • curprev 12:3312:33, 10 August 2023Simone.b talk contribs 44,299 bytes +11 Created page with "Sui sistemi Windows, un file batch può essere utilizzato in modo simile."
  • curprev 12:3212:32, 10 August 2023Simone.b talk contribs 44,288 bytes +16 Created page with "Dopo aver salvato questo script di shell, assicurarsi che abbia i permessi di esecuzione e che si trovi in una directory contenuta nel {{incode|PATH}} del tuo sistema."
  • curprev 12:3212:32, 10 August 2023Simone.b talk contribs 44,272 bytes +12 Created page with "Il programma {{incode|doxypypy_filter}} non esiste di default; dovrebbe essere creato come uno script di shell per eseguire {{incode|doxypypy}} con le opzioni appropriate e per prendere un file come primo argomento."
  • curprev 12:3212:32, 10 August 2023Simone.b talk contribs 44,260 bytes +35 Created page with "Quello che fa è che i file che corrispondono al modello, tutti i file con un'estensione che termina con {{incode|.py}}, passeranno attraverso il programma {{incode|doxypypy_filter}}. Ogni volta che Doxygen incontra tale file nell'albero dei sorgenti, il nome del file verrà passato come primo argomento a questo programma."
  • curprev 07:1607:16, 10 August 2023Simone.b talk contribs 44,225 bytes +20 Created page with "Per iniziare, non utilizzare direttamente il programma {{incode|doxypypy}}; invece, creare il file di configurazione con {{incode|doxygen -g}}, quindi modificare il {{incode|Doxyfile}} creato e modificare il seguente tag."
  • curprev 07:1507:15, 10 August 2023Simone.b talk contribs 44,205 bytes +44 Created page with "Nell'esempio precedente, la conversione dei blocchi di documentazione è stata eseguita manualmente con un solo file sorgente. Idealmente si desidera che questa conversione avvenga automaticamente, al volo, con qualsiasi numero di file Python. Per fare ciò, la configurazione Doxygen deve essere modificata di conseguenza."
  • curprev 07:1507:15, 10 August 2023Simone.b talk contribs 44,161 bytes +66 Created page with "=== Conversione immediata dello stile del commento ==="
  • curprev 07:1207:12, 10 August 2023Simone.b talk contribs 44,095 bytes −1 Created page with "La documentazione dovrebbe mostrare informazioni simili alle seguenti e creare collegamenti appropriati ai singoli moduli."
  • curprev 07:1207:12, 10 August 2023Simone.b talk contribs 44,096 bytes +13 Created page with "Per compilare, creare la configurazione ed eseguire {{incode|doxygen}} nella directory di livello superiore che contiene i file."
  • curprev 07:1207:12, 10 August 2023Simone.b talk contribs 44,083 bytes +22 Created page with "div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} (la parte superiore viene modificata manualmente, il resto rimane invariato)"
  • curprev 07:1107:11, 10 August 2023Simone.b talk contribs 44,061 bytes +55 Created page with "Nel nuovo file lo stile di commento è cambiato in modo che la riga diventi {{incode|##@package pyexample_pythonic}}, che ora sarà interpretata da Doxygen. Tuttavia, per essere interpretato correttamente, l'argomento deve essere modificato manualmente in modo che corrisponda al nome del nuovo modulo (file); dopo aver fatto questo la riga dovrebbe essere {{incode|##@package pyexample_doxygen}}."
  • curprev 07:1107:11, 10 August 2023Simone.b talk contribs 44,006 bytes +26 Created page with "Il file originale ha un commento in alto <code><nowiki>'''@package pyexample_pythonic</nowiki></code> che indica il modulo o lo spazio dei nomi che viene descritto dal file. Questa parola chiave {{incode|@package}} non viene interpretata quando si utilizzano le virgolette triple nel blocco dei commenti."

1 May 2023

  • curprev 10:0110:01, 1 May 2023Simone.b talk contribs 43,980 bytes +19 Created page with "Una volta che il programma {{incode|doxypypy}} è installato e accessibile dal terminale, un file Python con docstring Pythonic può essere riformattato in stile Doxygen con le seguenti istruzioni. Il programma invia il codice riformattato allo standard output, quindi reindirizza questo output a un nuovo file."
  • curprev 10:0010:00, 1 May 2023Simone.b talk contribs 43,961 bytes +15 Created page with "In alternativa, si può creare un collegamento simbolico al programma {{incode|doxypypy}}, posizionando il collegamento in una directory che è già inclusa nel {{incode|PATH}}."
  • curprev 10:0010:00, 1 May 2023Simone.b talk contribs 43,946 bytes −6 No edit summary
  • curprev 10:0010:00, 1 May 2023Simone.b talk contribs 43,952 bytes +14 Created page with "Se il pacchetto è stato installato come utente, potrebbe risiedere nella tua home directory, ad esempio in {{incode|$HOME/.local/bin}}. Se questa directory non è nel {{incode|PATH}} del tuo sistema, il programma non verrà trovato. Pertanto, aggiungi la directory alla variabile {{incode|PATH}}, nel tuo file {{incode|$HOME/.bashrc}} o nel tuo file {{incode|$HOME/.profile}}."
  • curprev 09:5909:59, 1 May 2023Simone.b talk contribs 43,938 bytes +59 Created page with "Se il comando {{incode|pip}} viene utilizzato senza l'opzione {{incode|--user}}, saranno necessari i privilegi di superutente (root) per installare il pacchetto, ma ciò non è necessario nella maggior parte dei casi; usare i permessi di root solo se sei certo che il pacchetto non entrerà in collisione con i pacchetti forniti dalla tua distribuzione."
  • curprev 09:5909:59, 1 May 2023Simone.b talk contribs 43,879 bytes +29 Created page with "Doxypypy può essere installato usando {{incode|pip}}, il programma di installazione dei pacchetti Python."
  • curprev 09:5809:58, 1 May 2023Simone.b talk contribs 43,850 bytes +2 No edit summary
  • curprev 09:5709:57, 1 May 2023Simone.b talk contribs 43,848 bytes +70 Created page with "=== Conversione dello stile Pythonico in stile Doxygen ==="
  • curprev 09:5709:57, 1 May 2023Simone.b talk contribs 43,778 bytes −4 Created page with "La documentazione dovrebbe mostrare informazioni simili alle seguenti e creare collegamenti appropriati ai singoli moduli e classi."
  • curprev 09:5709:57, 1 May 2023Simone.b talk contribs 43,782 bytes +29 Created page with "La compilazione della documentazione procede come per i sorgenti C++. Se entrambi i file Python, {{incode|pyexample_a.py}} e {{incode|pyexample_b.py}}, con uno stile di commento distinto si trovano nella stessa directory, verranno elaborati entrambi."
  • curprev 09:5609:56, 1 May 2023Simone.b talk contribs 43,753 bytes +51 Created page with "== Compilazione della documentazione =="
  • curprev 09:5609:56, 1 May 2023Simone.b talk contribs 43,702 bytes +10 Created page with "Nell'esempio seguente i blocchi di documentazione iniziano con doppi cancelletti {{incode|##}}. Uno appare all'inizio per spiegare il contenuto generale di questo modulo (file). Quindi ci sono blocchi prima delle definizioni di funzione, classe e metodo di classe e c'è un blocco dopo una variabile di classe. In questo modo, Doxygen estrarrà la documentazione, riconoscerà i comandi speciali {{incode|@package}}, {{incode|@param}} e {{incode|@var}} e formatterà il testo..."
  • curprev 09:5609:56, 1 May 2023Simone.b talk contribs 43,692 bytes +76 Created page with "=== Secondo stile: blocco di documentazione prima del codice ==="
  • curprev 09:5609:56, 1 May 2023Simone.b talk contribs 43,616 bytes +2 Created page with "def PyMethod(self): '''Documentazione per un metodo.''' pass }}"
  • curprev 09:5509:55, 1 May 2023Simone.b talk contribs 43,614 bytes −1 Created page with "def __init__(self): '''Il costruttore.''' self._memVar = 0"
  • curprev 09:5509:55, 1 May 2023Simone.b talk contribs 43,615 bytes +9 Created page with "class PyClass: '''Documentazione per una classe. Maggiori dettagli. '''"
  • curprev 09:5509:55, 1 May 2023Simone.b talk contribs 43,606 bytes +8 Created page with "def func(): '''Documentazione per una funzione. Maggiori dettagli. ''' pass"
  • curprev 09:5509:55, 1 May 2023Simone.b talk contribs 43,598 bytes +8 Created page with "{{Code|code= '''@package pyexample_a Documentazione per questo modulo. Maggiori dettagli. '''"
  • curprev 09:5409:54, 1 May 2023Simone.b talk contribs 43,590 bytes +15 Created page with "Nell'esempio seguente una docstring è all'inizio per spiegare i contenuti generali di questo modulo (file). Quindi le docstring appaiono all'interno delle definizioni di funzione, classe e metodo di classe. In questo modo Doxygen estrarrà i commenti e li presenterà così come sono, senza modifiche."
  • curprev 09:5409:54, 1 May 2023Simone.b talk contribs 43,575 bytes +57 Created page with "=== Primo stile: documentazione Pythonica ==="
  • curprev 09:5409:54, 1 May 2023Simone.b talk contribs 43,518 bytes +72 Created page with "Nota: * La prima opzione è preferita per rispettare [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8], [https://www.python.org/dev/peps/ pep-0257/ PEP257] e la maggior parte delle linee guida di stile per la scrittura di Python (vedere [https://realpython.com/python-pep8/ 1], [https://realpython.com/documenting-python-code/ 2]). Si consiglia di utilizzare questo stile se si intende produrre fonti documentate utilizzando [https://www.sphinx-doc.org/e..."
  • curprev 09:5209:52, 1 May 2023Simone.b talk contribs 43,446 bytes +74 Created page with "Esistono due modi per scrivere blocchi di documentazione per Python: # Il modo Pythonico, usando "docstrings", cioè un blocco di testo racchiuso tra <code><nowiki>'''virgolette triple'''</nowiki></code> subito dopo la definizione della classe o della funzione. # Il modo Doxygen, inserendo i commenti prima della definizione della classe o della funzione; in questo caso vengono utilizzati i doppi caratteri hash {{incode|##}} per iniziare il blocco di documentazione, e qui..."
  • curprev 09:5209:52, 1 May 2023Simone.b talk contribs 43,372 bytes +13 Created page with "Doxygen funziona meglio per linguaggi tipizzati staticamente come C++. Tuttavia, può anche creare [http://www.doxygen.nl/manual/docblocks.html#pythonblocks documentazione per i file Python]."
  • curprev 09:5109:51, 1 May 2023Simone.b talk contribs 43,359 bytes +45 Created page with "== Doxygen con codice Python =="
  • curprev 09:5109:51, 1 May 2023Simone.b talk contribs 43,314 bytes +172 Created page with "Il testo all'interno di uno speciale blocco di documentazione viene analizzato prima di essere scritto nei file di output HTML e LaTeX. Durante l'analisi si verificano i seguenti passaggi: * La formattazione Markdown è sostituita dall'HTML corrispondente o da comandi speciali. * Vengono eseguiti i comandi speciali all'interno della documentazione. Vedere la sezione [http://www.doxygen.nl/manual/commands.html Comandi speciali] nel manuale per una spiegazione di ciascun c..."
  • curprev 09:5009:50, 1 May 2023Simone.b talk contribs 43,142 bytes +60 Created page with "== Analisi dei blocchi della documentazione =="
  • curprev 09:0609:06, 1 May 2023Simone.b talk contribs 43,082 bytes +64 Created page with "Prima intestazione | Seconda intestazione ----------------------| --------------------- Contenuto della Cella | Contenuto della Cella Contenuto della Cella | Contenuto della Cella"
  • curprev 09:0409:04, 1 May 2023Simone.b talk contribs 43,018 bytes +2 Created page with "Le seguenti sono estensioni di Markdown. <pre> [TOC]"
  • curprev 09:0409:04, 1 May 2023Simone.b talk contribs 43,016 bytes +10 Created page with "![Testo della didascalia](/path/to/img.jpg)"
  • curprev 09:0409:04, 1 May 2023Simone.b talk contribs 43,006 bytes +4 Created page with "[Il testo del link](http://example.net/)"
(newest | oldest) View ( | ) (20 | 50 | 100 | 250 | 500)