Génie logiciel javadocs

6

Récemment, j'ai travaillé sur la refactorisation de parties de la base de code que je traite actuellement - non seulement pour mieux le comprendre moi-même, mais aussi pour le rendre plus facile pour les autres qui travaillent sur le code. J'ai tendance à me pencher du côté de penser que …

18 java documentation refactoring javadocs

3

Comment documenter des API expérimentales ou incomplètes comme @deprecated?

Existe-t-il un bon terme similaire mais différent de «obsolète» pour signifier qu'une méthode ou une API est dans la base de code mais ne doit pas être utilisée car son implémentation n'est pas complète ou va probablement changer? (Ouais, je sais, ces méthodes ne devraient pas être publiques, yada yada …

12 documentation terminology api documentation-generation javadocs

2

Déconseillé ou dénigré dans JavaDoc?

Dans le JavaDoc, X509Certificate getSubjectDN()il indique: Dénigré , remplacé par getSubjectX500Principal (). J'ai l'habitude de voir Obsolète dans les méthodes for qui ne devraient plus être utilisées, mais pas dénigrées. J'ai trouvé un rapport de bug sur ce cas particulier où il a été fermé avec un commentaire: Ce n'est …

11 java terminology javadocs

1

Comment garder à jour les exemples de code dans javadocs

Je travaille sur une petite bibliothèque qui fournit des implémentations de métriques de chaîne de base bien connues. Surtout pour ma propre éducation. Le développement se produit donc chaque fois que j'ai un peu de temps libre. Pour cette raison, j'ai automatisé la plupart des processus afin que je puisse …

9 java documentation javadocs

2

Manière sèche d'écrire Javadoc sur les méthodes de surcharge

Je veux écrire Javadoc de manière SECHE. Mais le document Oracle sur Javadoc dit à nouveau d'écrire la même chose dans le commentaire de la méthode de surcharge. Puis-je éviter la répétition?

9 documentation comments dry javadocs

Questions marquées «javadocs»