Enrich sequence diagram with JavaDoc comments

オープン
#279 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
java
領域
tooling

調査の方向性

まず、この Java エージェントがどのようにシーケンス図を生成し、メソッドまたは呼び出しポイントのコンテキストがどのように表現されているかを確認します。要求されている JavaDoc 抽出を、リンク先の extract-javadoc プロジェクトおよび作者のアスペクトベースの計装アプローチと比較します。完了の条件は、シーケンス図がプログラマーではない人にも役立つ自然言語のメソッドコンテキストを公開することです。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Java
スター
88
フォーク
17
平均マージ
2日 2時間
マージ済み PR(30日)
1

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

getappmap/appmap-java のほかの issue

getappmap/appmap-java の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。