mcquerol / mcquerol/java-projects
create doxygen style comments for each one
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1
- Forks
- 0
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Dieses Issue hat keine Beschreibung.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Untersuchung der Java-Projekte des Repositorys und liste die Klassen oder Methoden auf, die durch „jede einzelne“ abgedeckt sind; im Issue werden keine bestimmten Dateien genannt. Definiere die Fertigstellung als das Hinzufügen von Kommentaren im Doxygen-Stil im gesamten vereinbarten Umfang und überprüfe anschließend die resultierende Dokumentation auf Konsistenz.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100