Enrich sequence diagram with JavaDoc comments

Aberta
#279 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
java
Domínio
tooling

Direção de pesquisa

Comece analisando como este agente Java produz diagramas de sequência e como o contexto de métodos ou pontos de chamada é representado. Compare a extração de JavaDoc solicitada com o projeto extract-javadoc vinculado e com a abordagem de instrumentação baseada em aspectos do autor; considera-se concluído quando os diagramas de sequência expuserem um contexto de métodos útil em linguagem natural para não programadores.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Java
Estrelas
88
Forks
17
Merge médio
2d 2h
PRs com merge (30d)
1

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de getappmap/appmap-java

Todas as issues de getappmap/appmap-java

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.