6
È necessario generare javadoc come parte del processo di compilazione?È necessario generare javadoc come parte del processo di compilazione?
A
risposta
1
No, non è necessario
11
Beh non c'è nulla di veramente ti costringe a farlo, ma se si desidera distribuire i vostri artefatti costruire come una libreria utilizzabile aiuta di certo di aver ben scritto Javadocs che le persone possono sfogliare prima anche loro scaricano il tuo JAR.
3
No. Ciò che si sceglie di fare in un processo di compilazione dipende da voi (o dal cliente). Alcuni sistemi di compilazione possono includere la generazione di JavaDoc per impostazione predefinita, ma dovrebbe essere semplice da disabilitare.
1
Non si menziona se questa è una build per, diciamo, un'app Web o una libreria per la distribuzione. Come altri recensori hanno menzionato, non è veramente necessario, ma sia per una web app mantenuta internamente che per una libreria distribuita esternamente, la documentazione (sotto forma di javadoc) sarà estremamente utile.
0
Se il processo di compilazione utilizza Ant, direi che potrebbe non essere necessario, ma farlo non dovrebbe essere affatto un problema. Basta usare l'attività javadoc, generarla e farla finita.
1
Niente affatto.
Se la maggior parte degli utenti del codice accede direttamente ai file Java e utilizza un IDE, probabilmente sta già leggendo i propri JavaDocs tramite il passaggio del mouse nell'editor di codice. Potrebbe essere più aggiornato rispetto alla versione che è stata archiviata o che è stata creata (a meno che non si abbiano build continue).
Se si espongono versioni temporanee ai client (ad esempio, si è un progetto open source), quindi fornire JavaDocs anziché solo file di classe si lega ulteriormente a una semantica specifica. Ha senso fornire un controllo più rigoroso sulla tua API e i tuoi JavaDocs descrivono essenzialmente la tua API.
Se non si desidera che qualcuno esterno utilizzi le proprie interfacce pubbliche (ad esempio, le si mantiene aperte ai futuri plug-in), non è possibile impedirlo, ma si può certamente evitare di incoraggiarlo fornendo JavaDocs.
0
È decidere se è necessario o meno. Personalmente, non creo javadoc e altri rapporti pesanti (che sono un po 'costosi da generare) ad ogni build, voglio mantenere la generazione eseguita su macchine sviluppatore e tramite il motore di integrazione continua il più veloce possibile (tuttavia, il motore di integrazione continua crea e pubblica i jar sorgente). La generazione dei rapporti viene eseguita durante la costruzione notturna.
0
È necessario generare javadoc come parte del processo di compilazione?
No
Problemi correlati
- 1. Genera proxy WCF come parte del processo di compilazione
- 2. Code Signing come parte del processo di compilazione
- 3. Come generare Javadoc dalla riga di comando
- 4. Come posso generare JavaDoc senza frame?
- 5. Come posso generare commenti Javadoc in Eclipse?
- 6. Come generare documentazione javadoc con dieresi?
- 7. Automazione della creazione del pacchetto NuGet come parte del processo di creazione
- 8. Collegamento al processo di compilazione di Roslyn
- 9. Come utilizzare Gradle per generare JavaDoc in Android Studio?
- 10. Come generare javadoc usando ubuntu + eclipse nel mio progetto
- 11. Come generare javadoc con formica, per un progetto esistente?
- 12. Come generare collegamenti al riferimento delle classi Android in javadoc?
- 13. Compilazione del codice C++ 11 come parte di un file mex MATLAB
- 14. C# - Uccidere un processo da una parte del suo nome
- 15. Come impedire a VS 2008 di pubblicare cartelle .svn come parte del processo di pubblicazione?
- 16. Maven controlla lo stile come parte della compilazione
- 17. Qual è il processo eseguito durante la compilazione Objective-C
- 18. Qual è lo stato stack del kernel del processo Linux durante la creazione del processo?
- 19. Come posso imparare a configurare un processo di compilazione?
- 20. Come generare il simbolo di debug di gcc al di fuori del target di compilazione?
- 21. Come funziona il processo di compilazione di Android?
- 22. KillTimer è necessario?
- 23. Maven javadoc: javadoc funziona ma javadoc: aggregato genera errori che sembrano errori del compilatore
- 24. Generazione CSS Sprite nel processo di compilazione gradle?
- 25. Come generare documentazione in stile javadoc per progetto solo Scala in sbt?
- 26. È ancora necessario rmic?
- 27. Grandi progetti Android: come velocizzare il processo di compilazione?
- 28. Shortcode che viene visualizzato nella parte superiore del contenuto anziché nel punto in cui è necessario.
- 29. javadoc senza nome del pacchetto
- 30. generazione javadoc come documento word