getappmap / getappmap/appmap-java

Enrich sequence diagram with JavaDoc comments

Aperta
#279 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Java
Stelle
88
Fork
17
Merge medio
2g 2h
PR unite (30g)
1

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando come questo agente Java produce diagrammi di sequenza e come viene rappresentato il contesto dei metodi o dei punti di chiamata. Confronta l’estrazione di JavaDoc richiesta con il progetto extract-javadoc collegato e con l’approccio di strumentazione basato sugli aspetti dell’autore; il lavoro è completato quando i diagrammi di sequenza espongono un contesto dei metodi utile, in linguaggio naturale, per i non programmatori.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.