6
Est-il nécessaire de générer javadoc dans le cadre du processus de construction?Est-il nécessaire de générer javadoc dans le cadre du processus de construction?
A
Répondre
1
Non, ce n'est pas nécessaire
11
Eh bien, il n'y a vraiment rien qui vous oblige à le faire, mais si vous souhaitez distribuer vos objets de construction comme une bibliothèque utilisable, il est certainement utile d'avoir bien écrit Javadocs que les gens peuvent parcourir avant ils téléchargent même votre JAR.
3
Non. Ce que vous choisissez de faire dans un processus de construction dépend de vous (ou du client). Certains systèmes de construction peuvent inclure la génération JavaDoc par défaut, mais il devrait être simple à désactiver.
1
Vous ne mentionnez pas s'il s'agit d'une version pour, disons, une application Web ou pour une bibliothèque à distribuer. Comme d'autres réplicateurs l'ont mentionné, ce n'est pas vraiment nécessaire, mais pour une application web maintenue en interne et une bibliothèque distribuée en externe, la documentation (sous la forme de javadoc) sera extrêmement utile.
0
Si votre processus de construction utilise Ant, je dirais que ce n'est peut-être pas nécessaire, mais le faire ne devrait pas être une difficulté du tout. Vous utilisez simplement la tâche javadoc, la générez et vous en terminez.
1
Pas du tout.
Si la plupart des utilisateurs de votre code accèdent directement aux fichiers Java et utilisent un IDE, ils lisent probablement leurs JavaDocs via les survols dans l'éditeur de code. Cela peut être plus à jour que la version qui est enregistrée ou qui est construite (sauf si vous avez des versions continues).
Si vous exposez des versions intermédiaires à des clients (par exemple, vous êtes un projet open source), la fourniture de JavaDocs plutôt que de fichiers de classe vous permet en outre de vous lier à une sémantique spécifique. Il est logique de fournir un contrôle plus strict sur votre API et vos JavaDocs décrivent essentiellement votre API. Si vous ne voulez pas d'utilisateurs externes utilisant vos interfaces publiques (par exemple, vous les gardez ouverts aux futurs plug-ins), vous ne pouvez pas l'empêcher, mais vous pouvez certainement éviter de l'encourager en fournissant JavaDocs.
0
Vous décidez si c'est nécessaire ou non. Personnellement, je ne génère pas de javadoc et d'autres rapports lourds (qui sont un peu coûteux à générer) à chaque build, je veux garder la construction s'exécuter sur les machines de développement et par le moteur d'intégration continue aussi vite que possible (le moteur d'intégration continue construit et publie des fichiers sources bien que). La génération de rapports est effectuée pendant la génération nocturne.
0
Est-il nécessaire de générer javadoc dans le cadre du processus de construction?
Pas