Enrich sequence diagram with JavaDoc comments

Ouverte
#279 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
À l'abandon
Stack technique
java
Domaine
tooling

Piste de recherche

Commencez par examiner comment cet agent Java produit des diagrammes de séquence et comment le contexte des méthodes ou des points d’appel est représenté. Comparez l’extraction de JavaDoc demandée avec le projet extract-javadoc lié et l’approche d’instrumentation fondée sur les aspects de l’auteur ; le travail est terminé lorsque les diagrammes de séquence exposent un contexte de méthode en langage naturel utile aux non-programmeurs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

It would be useful to have more context for methods and call points in sequence diagrams. This would allow them to be demonstrated to analysts, customers and the product owner - people who do not have programming skills, but understand natural language.

In the past, I've made diagrams like this using my aspect-based instrumentation code and comment extractor from Java project sources.

Langage dominant
Java
Étoiles
88
Forks
17
Merge moyen
2 j 2 h
PR mergées (30 j)
1

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de getappmap/appmap-java

Toutes les issues de getappmap/appmap-java

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.