redhat-developer / redhat-developer/vscode-java
Improve readability of javadoc
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 2.3k
- Fork
- 546
- Merge medio
- 20h 1m
- PR unite (30g)
- 11
Descrizione
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.
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Iniziare riproducendo la visualizzazione di JavaDoc nell’editor Visual Studio Code per gli oggetti Java provenienti da file locali e dipendenze referenziate tramite Maven o Gradle. Confrontare il risultato attuale formattato come codice con il formato leggibile dalle persone richiesto e definire la copertura per tutti gli oggetti referenziati prima di identificare il punto di ingresso dell’estensione e i test appropriati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java, typescript, vscode
- Ambito
- developer-experience, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 30/100