Doxygen, sistema di documentazione codice

Premessa

Finalmente ci siamo... dopo settimane se non mesi passati a programmare ecco che il software che avevi pensato tempo fa e al quale hai dato forma nel tempo pronto per il suo debutto...
Lo fai girare, lo osservi mentre legge la configurazione e... tutto sembra funzionare.
A quel punto, dopo la soddisfazione iniziale arriva l'incubo del programmatore: documentare il proprio codice per fare in modo che se qualcun altro o tu stesso fra due anni devi modificare il programma, sappia cosa faceva quella specifica funzione...
A questo scopo sono a presentarvi Doxygen, un sistema di documentazione del codice molto semplice e potente.

Doxygen

Doxygen è un software che legge uno o più file contenenti del codice di programmazione.
Analizza i commenti presenti e, se formattati adeguatamente, genera della documentazione fruibile.
Detto in altre parole, basta inserire commenti nel proprio codice che spieghino in modo dettagliato le funzioni, le variabili, le classi (pratica di solito sempre auspicabile) e Doxygen farà il resto...
Questo software multipiattaforma (gira su Linux, Windows e Mac) è nato per la documentazione del codice in C ma oggi riconosce codice in Java, python, perl, php e molti altri.
La cosa più interessante di questo software è la semplicità d'uso: dopo aver aperto una utility grafica che aiuta nella creazione di un file di configurazione, basta lanciare l'eseguibile doxygen e, come per magia, vedrete apparire la documentazione nella cartella specificata.
Una caratteristica affasciante sono gli output disponibili in questo software: la documentazione, infatti, può essere generata in un gradevole formato HTML (estremamente configurabile con CSS) pronto da pubblicare su un sito web o una intranet, in formato RTF o LaTeX (e quindi PDF).
Insomma, per chi sta cercando un modo semplice e veloce per documentare il proprio codice, Doxygen è un ottimo punto di partenza, semplice, veloce, estremamente configurabile, multipiattaforma e multilinguaggio. In poche parole è solo da provare!

Cheatsheet

Il cheatsheet è un documento nel quale sono scritti comandi, sintassi ma soprattutto i trucchi di un linguaggio di programmazione specifico o un programma in generale. L'altro giorno, facendo qualche ricerca su Google mi sono imbattuto in una bella lista che vi ripropongo in questo post. Se volete l'elenco completo potete cliccare qui o in maniera più ordinata a questo link.
Ho fatto una cernita dei cheatsheet più interessanti per me ed ecco una breve sintesi qui di seguito:

• apache cheatsheet. Apache è il può famoso web server che ci sia in circolazione.
  
• htaccess cheatsheet. Htaccess è un file che si mette in una directory apache per inibire alcuni comportamenti o obbligarne degli altri all'utente che si appresta a navigare sulla cartella specifica.
  
• ascii character codes table: assolutamente da avere, associa ad ogni lettera o simbolo il proprio codice ascii
  
• character entity reference in HTML: è un elenco di come creare lettere accentate, simboli particolari (come > o <) in maniera corretta con standard W3C su file HTML
  
• CSS: imperdibile foglio che riassume le caratteristiche di un Cascading Style Sheet anche detto foglio di stile
  
• CVS: CVS è un metodo che si avvale della tecnologia client/server per il mantenimento del codice software. Utilissimo quando si è gli unici programmatori, diventa indispensabile se si lavora in team
  
• python 101 cheatsheet e reference python: due reference del linguaggio di programmazione python
  
• django, reference comandi : è un framework scritto in python che permette un rapido e veloce sviluppo di applicazioni o semplici pagine web in python
• SQL: Structured Query Language, un linguaggio semplicissimo ma altrettanto potente che serve per interrogare database, inserire, eliminare record. E' lo standard della programmazione su un database.
• perl Regular Expression: Espressioni regolari in linguaggio di programmazione Perl
• perl Quick Reference: Un veloce riferimento a Perl
• linux shortcut: comandi e scorciatoie in linux
• list ports: i servizi di un server sono in ascolto su porte diverse. Ecco un elenco dei più famosi.
• vim essential e vim scheda rapida e vim commands: vim è un editor di testo potentissimo. Indispensabile ambiente linux/unix, utilissimo su qualsiasi sistema operativo si utilizzi.
• blogger : un cheatsheet per blogger