getappmap / getappmap/appmap-java
Enrich sequence diagram with JavaDoc comments
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Java
- Estrellas
- 88
- Forks
- 17
- Merge medio
- 2 d 2 h
- PR fusionados (30 d)
- 1
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza revisando cómo este agente Java produce diagramas de secuencia y cómo se representa el contexto de los métodos o puntos de llamada. Compara la extracción de JavaDoc solicitada con el proyecto extract-javadoc enlazado y el enfoque de instrumentación basado en aspectos del autor; se considerará terminado cuando los diagramas de secuencia expongan un contexto de métodos útil en lenguaje natural para personas no programadoras.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100