133794m3r / 133794m3r/itp132-232

Add documentation

Offen
#11 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C++
Sterne
0
Forks
0
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Eventually I'll write some documentation. Not sure how I'll do it yet but I'll find some way.

- [ ] Matrix Class
- [ ] Hill Cipher Class

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Suchen Sie nach vorhandenen Matrix- und Hill-Cipher-Klassen im Repository, um deren Struktur und Zweck zu verstehen. Beginnen Sie mit dem Lesen der Quelldateien, um zu sehen, welche Methoden und Funktionen dokumentiert werden müssen. Bestimmen Sie das Dokumentationsformat (z. B. Kommentare, README oder einen separaten docs-Ordner) und schreiben Sie Erklärungen zur Verwendung jeder Klasse sowie Beispiele.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.