Add a documentation class instead of a formatted string.
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
Rechercherichtung
Es werden keine Dateien oder Tests genannt. Beginne damit nachzuverfolgen, wo Dokumentationsstrings von Funktionen definiert, geparst und verwendet werden; identifiziere die derzeit im Format kodierten Felder. Fertig ist die Aufgabe, wenn die Dokumentation durch eine Klasse mit Feldern wie Beschreibung, Rückgabetyp, Argumenten und Name dargestellt wird, alle bestehenden Verbraucher aktualisiert sind und durch die relevanten Tests des Projekts abgedeckt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
CMDHELPER-2915 - Reported by ACzChef
Right now functions have to pass in a string for their docs, that then later gets parsed into usable data.
My suggestion is to have a documentation class where you just define all the fields such as description, return type, arguments, name, etc. and use that instead. It would be cleaner, and less error prone.
- Vorherrschende Sprache
- Java
- Sterne
- 128
- Forks
- 70
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus EngineHub/CommandHelper
-
discussion wanted documentation
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
EngineHub/CommandHelper#1403 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
EngineHub/CommandHelper#1370 · 1 Kommentar ·
-
bug
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
EngineHub/CommandHelper#1354 ·
-
bug
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
EngineHub/CommandHelper#1349 · 3 Kommentare ·
-
bug
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
EngineHub/CommandHelper#1341 · 2 Kommentare ·
Alle Issues in EngineHub/CommandHelper
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
apache/rocketmq-dashboard#6610 ·
Maintainer antworten meist innerhalb von 3 Tagen
-
`RedisList.reversed()` view returns an empty `range` and `trim` removes all elementsEvtl. vergeben @CCCLL hat das heute übernommen. Offenstatus: waiting-for-triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
spring-projects/spring-data-redis#3461 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 73/100
javapathfinder/jpf-core#649 ·
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
devops-thiago/ThrillhouseBot#1093 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 67/100
wimdeblauwe/htmx-spring-boot#205 ·