getappmap / getappmap/appmap-java
Enrich sequence diagram with JavaDoc comments
オープン
まだ誰も着手していません。
- 主要言語
- Java
- スター
- 88
- フォーク
- 17
- 平均マージ
- 2日 2時間
- マージ済み PR(30日)
- 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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、この Java エージェントがどのようにシーケンス図を生成し、メソッドまたは呼び出しポイントのコンテキストがどのように表現されているかを確認します。要求されている JavaDoc 抽出を、リンク先の extract-javadoc プロジェクトおよび作者のアスペクトベースの計装アプローチと比較します。完了の条件は、シーケンス図がプログラマーではない人にも役立つ自然言語のメソッドコンテキストを公開することです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100