Degli oltre cinquanta plugin jQuery scaricati negli ultimi mesi ne ho usati si e no due. Tutti gli altri presentavano delle carenze a livello di design e di progettazione. In questo articolo vorrei riassumere gli errori maggiori che ho riscontrato in questi plugin. Spero che questa lista vi sia utile per scrivere plugin migliori.
Mancanza di documentazione
Un plugin dovrebbe essere ben documentato. Un plugin senza documentazione non serve a nulla e fa solo perdere del tempo a chi vuole usarlo. La documentazione dovrebbe essere dettagliata, possibilmente dedicando più pagine a questa parte specie se il plugin è complesso e ha molte opzioni.
Mancanza di esempi
Un plugin senza esempi non serve a nulla. Gli esempi dovrebbero essere atomici. Una cosa che non vedo quasi mai negli esempi sono gli snippet di codice per farli funzionare. Guardare il sorgente si rivela spesso un'inutile perdita di tempo.
Scarsa flessibilità
Un plugin dovrebbe adattarsi alla struttura della pagina che lo ospita e non il contrario. Un plugin che esige una sola struttura HTML per funzionare è un plugin scarsamente flessibile.
Scarsa performance
Un plugin non dovrebbe mai rallentare il caricamento o le azioni della pagina. Un plugin che presenta questo problema è da evitare. Testate il vostro plugin prima nei browser con performance inferiore e solo dopo in quelli con performance migliore. Cercate di usare soluzioni che permettano anche ai browser con performance inferiore di eseguire il vostro plugin senza eccessivi rallentamenti. Se ciò non è possibile, indicatelo nella documentazione.
Mancanza di test
Un plugin che afferma di supportare Internet Explorer dalla versione 6 in poi non può non testare il suo codice in questo browser. Ho visto decine di plugin riportare questa affermazione nelle loro presentazioni, salvo poi scoprire che non era affatto vero. Siate sinceri: se il vostro plugin non funziona perfettamente in IE, ditelo chiaramente.
Mancanza di commenti nel codice
Praticamente nessun plugin che ho visto sinora usa dei commenti strutturati nel codice (per esempio JSDoc). I commenti sono importanti qualora si decidesse di voler modificare il vostro plugin per adattarlo ad esigenze particolari.
Download incompleto
Il download del plugin dovrebbe comprendere:
- versione estesa del plugin
- versione compressa/ridotta del plugin
- demo ed esempi
- documentazione
- una versione di jQuery di riferimento
Questo è fondamentale per evitare che l'utente ogni volta debba collegarsi al sito per vedere gli esempi o leggere la documentazione.