Il modello standard JavaDoc (Doclet) non è cambiato molto fino al recente JDK7. A mio parere, il modello JDK7 ha reso ancora più difficile la navigazione. Ho esaminato diversi doclet di terze parti, ma nessuno è quello che voglio. Così ho iniziato a progettare da zero un nuovo template JavaDoc open source per migliorare l'usabilità. Ecco qualcosa a cui ho pensato,
- Ricerca. Dovrebbe essere fatto dal lato client per farlo funzionare sul tuo file system locale.
- navigazione interattiva simile a IDE. Lo standard JavaDoc utilizza due frame per mostrare separatamente pacchetti e classi, che è molto meno utilizzabile di un navigatore di tipo Eclipse. Ciò che ha reso ancora peggio è che se si fa clic all'interno del frame di destra, l'indice del pacchetto e l'indice di classe non si aggiorna di conseguenza. Non hai idea di dove ti trovi.
- URL. Uno svantaggio dei frame è che l'URL non cambia in base ai frame. È molto frustrante non poter inviare un URL JavaDoc a qualcuno a meno che tu non controlli esplicitamente l'URL del singolo frame.
- Guarda e senti. Non è necessario essere un designer per vedere che JavaDoc è brutto. Voglio migliorare JavaDoc e voglio assicurarmi di farlo bene. La domanda a cui rispondere è
Cosa ti aspetti che dovrebbe essere un JavaDoc migliore?