getappmap / getappmap/appmap-java

Enrich sequence diagram with JavaDoc comments

未关闭
#279 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Java
星标
88
派生
17
平均合并
2 天 2 小时
30 天内合并 PR
1

描述

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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先查看此 Java agent 如何生成序列图,以及方法或调用点上下文是如何表示的。将所请求的 JavaDoc 提取与链接的 extract-javadoc 项目以及作者基于切面的插桩方法进行比较;当序列图向非程序员展示有用的自然语言方法上下文时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。