Documentazione e Codice

Ciao a tutti, apro un topic per soddisfare una mia curiosità.

Quanti di voi sfruttano la possibilità di vedere il codice sorgente di Yii nella ricerca della soluzione di un problema o per una approfondimento al fine di colmare una lacuna di documentazione?

Mi sono accorto che spesso alcuni elementi di questo splendido framework sono poco documentati, mentre magari nel codice si individuano dei commenti chiarificatori.

A quanti di voi è capitato?

Guarda, io l’ho fatto molto poco. L’unica cosa interessante che ho scoperto, è che posso usare il traduttore di Yii e forzare la lingua da tradurre:


Yii::t('categoria', 'SourceLanguage', null, null, 'fr');

Non mi ha cambiato la vita ma… ma ogni tanto fa bene sbirciare sotto al motore.

In realtà, comunque, nella documentazione c’è scritto :P

http://www.yiiframework.com/doc/api/1.1/YiiBase#t-detail

I commenti chiarificatori di cui parli sono gia’ tutti nella api, e’ proprio in base a questi commenti che viene generata la guida.

Io di solito apro il codice solo se devo estendere un oggetto, per copiare come fa il framework e poi scrivere le mia funzione modificata.

Hai ragione, la documentazione è interamente generata dai commenti. Tuttavia l’accesso al codice a volte ci semplifica la comprensione dell’uso di alcune cose. Ti faccio un esempio banale di quello che intendo:

mi serviva customizzare le items di un CJuiSelectable, ma nella documentazione della proprietà itemTemplate del widget ho trovato indicazioni specifiche ma nessun esempio.

Ovviamente la documentazione sarebbe di per sè sufficiente per una persona che ha già una discreta esperienza del funzionamento del framework. Per gli altri invece sarebbe meglio trovare un esempio di come si fa… Sul forum 0 post sull’argomento :)

Guardando nel codice ho visto come è gestita di default la proprietà itemTemplate e ho potuto risolvere così la mia esigenza.

Ciao!

Credo che la documentazione sia generata in automatico da un phpDoc o simile. Non ci voglio nemmeno credere che uno si è messo li a scrivere tutto a mano.

La api contiene tutte le informazioni necessarie, la questione e’ capire dove stanno.

Io ho scritto un articolo per aiutare i nuovi utenti, non so se serve veramente, comunque prova a leggerlo.

Quello che fai notare tu e’ verissimo: la api ti aiuta se sai gia’ cosa devi fare, e se non lo sai?

A questo non ho ancora trovato una risposta…

Se il problema è “come faccio a sapere cosa non so” … la soluzione potrebbe essere A) Leggere tutta la documentazione B) creare uno strumento dove chi “studia” possa dire “ora lo so”. In questo modo tutto quello che è saputo, non viene più riconsigliato. E chi usa questo strumento è costretto a ritrovarsi davanti solo cose che non ha detto di sapere.

In realtà io spesso so cosa devo realizzare, ma non conoscendo a menadito lo strumento, cerco di capire qual’è la soluzione migliore. Leggere documentazione, analizzare il codice del framework e cercare nel forum le risposte date da utenti più esperti mi sembrano dei buoni punti di partenza :)

Comunque il tuo Tip è assolutamente prezioso: l’ho letto e votato !!

Grazie mille per l’appoggio!!

In generale se ti serve qualche feature globale (tipo utente, session, database chache o similari) guardati la classe CWebApplication (che nel codice si chiama Yii::app()). Se ha qualche proprieta’ dal nome interessante, di solito hai trovato quello che cerchi.

Ciao a tutti,sono un nuovo utente e sto cercando della documentazione di base per muovere i primi passi.Facendo un pò di ricerche in rete, ho visto il progetto di traduzione in italiano della guida,

http // code . google . com / p / yiidoc / TransGiudeItalian

(sono newbie e non posso ancora postare link)

che è un’ottima idea. Perché così è possibile imparare più velocemente, senza subire i rallentamenti di chi magari conosce l’inglese solo a livello scolastico.Dalla percentuale di avanzamento lavori, mi pare di capire che ci sia già un bel pò di materiale tradotto, che però non ho poi trovato nella pratica.Qualcuno di voi conosce per caso il link alla risorsa?Grazie