redhat-developer / redhat-developer/vscode-java

Improve readability of javadoc

Ouverte
#3,773 8 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

enhancement javadoc
Langage dominant
TypeScript
Étoiles
2.3k
Forks
546
Merge moyen
20 h 1 min
PR mergées (30 j)
11

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par reproduire l’affichage de JavaDoc dans l’éditeur Visual Studio Code pour les objets Java provenant de fichiers locaux et de dépendances référencées via Maven ou Gradle. Comparez le résultat actuel formaté comme du code avec le format lisible par l’humain demandé et définissez la couverture de tous les objets référencés avant d’identifier le point d’entrée de l’extension et les tests appropriés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java, typescript, vscode
Domaine
developer-experience, documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.