redhat-developer / redhat-developer/vscode-java

Improve readability of javadoc

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

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

enhancement javadoc
主要言語
TypeScript
スター
2.3k
フォーク
546
平均マージ
20時間 1分
マージ済み PR(30日)
11

説明

It would be great if we can read the javado in visual studio editor in an human readable format, instead the code format.

Current Result

Reading documentation in this format is hard.
image

Expected Result

Having a away to read it in an human readable format, in all objects (files in vscode or referenced through maven or gradel)

Additional Informations

If this already exists, sorry and please let me know.

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

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

はじめの一歩

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

調査の方向性

まず、ローカルファイルおよび Maven または Gradle を通じて参照される依存関係にある Java オブジェクトについて、Visual Studio Code エディターでの JavaDoc 表示を再現します。現在のコード形式の結果を、要求された人間が読みやすい形式と比較し、参照されるすべてのオブジェクトのカバレッジを定義してから、拡張機能のエントリポイントと適切なテストを特定します。

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

評価

技術スタック
java, typescript, vscode
領域
developer-experience, documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

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

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