Sto lavorando su una piccola libreria che fornisce implementazioni di metriche di base e ben note. Principalmente per la mia educazione. Quindi lo sviluppo accade ogni volta che ho un po 'di tempo libero.
Per questo motivo ho automatizzato la maggior parte dei processi in modo da poter rilasciare una versione tutte le volte che ci lavoro senza troppi sforzi. Tuttavia, mantenere il documento Java è ancora un problema perché include esempi.
Man mano che l'API evolve, devo controllare manualmente ogni esempio più e più volte. C'è un modo migliore per farlo?
Ho preso in considerazione di spostare la documentazione e gli esempi in un progetto separato (ad es. Esercitazione su Caliper ) in modo che possa essere rielaborato e compilato insieme al codice normale. Tuttavia ciò sposta la documentazione lontano dalla classe di cui tratta.
Quindi sì. Mi piacerebbe avere la mia torta e mangiarla anch'io. : D
* <h2>Tokenization</h2>
*
* Tokenization cuts up a string into tokens e.g.
* <code>chilperic ii son of childeric ii</code> is tokenized into
* <code>[chilperic, ii, son, of,
* childeric, ii]</code>. Tokenization can also be done repeatedly by tokenizing
* the individual tokens e.g.
* <code>[ch,hi,il,il,lp,pe,er,ri,ic, ii, so,on, of, ch,hi,il,ld,de,er,ri,ic, ii]</code>
* <p>
*
* <pre>
* <code>
* {@code
* return new StringMetricBuilder()
* .with(new SimonWhite<String>())
* .tokenize(new Whitespace())
* .tokenize(new QGram(2))
* .build();
* }
* </code>
* </pre>
*
* <p>
Se quanto sopra è troppo astratto. Questo è un esempio di documentazione. Attualmente sto aggiungendo costruttori statici come consigliato da Effective Java, ad es. Tokenizers.createQGram(2) durante il deprezzamento del metodo del costruttore. Ogni volta che faccio qualcosa di simile, dovrei aggiornare il codice di esempio sopra e controllare se funziona ancora.