Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add a documentation class instead of a formatted string.

Aperta
#914 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java
Ambito
tooling

Direzione di ricerca

Non vengono indicati file o test. Inizia tracciando dove vengono definite, analizzate e utilizzate le stringhe di documentazione delle funzioni; identifica i campi attualmente codificati nel formato. Il lavoro è completato quando la documentazione è rappresentata da una classe con campi quali descrizione, tipo restituito, argomenti e nome, tutti i consumer esistenti sono aggiornati e coperti dai test pertinenti del progetto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation engineering

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.

Lingua principale
Java
Stelle
128
Fork
70
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di EngineHub/CommandHelper

Tutte le issue di EngineHub/CommandHelper

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.