| ... | ... | @@ -112,3 +112,45 @@ Das Frontend von DEXWeb ist mit React und thirdweb gebaut und befindet sich im * |
|
|
|
```plaintext
|
|
|
|
|
|
|
|
```
|
|
|
|
# Smart Contract Dokumentationsprozess
|
|
|
|
|
|
|
|
## Überblick
|
|
|
|
|
|
|
|
Dieser Prozess beschreibt die Erstellung einer umfassenden Dokumentation für einen Smart Contract, von der Generierung der JSON-Dokumentation bis zur Darstellung als Webseite.
|
|
|
|
|
|
|
|
## Erstellung der JSON-Dokumentation
|
|
|
|
|
|
|
|
- Verwendung des Solidity-Compilers (solc) zur Generierung einer JSON-Ausgabe des Smart Contracts.
|
|
|
|
- Konfiguration der Compiler-Einstellungen für die Ausgabe von ABI, Bytecode, Methoden-Identifikatoren, Metadaten sowie User- und Developer-Dokumentation.
|
|
|
|
- Ergebnis: solc-output.json mit detaillierten Informationen über den Contract.
|
|
|
|
|
|
|
|
## Umwandlung von JSON zu Markdown
|
|
|
|
|
|
|
|
- Erstellung eines Node.js-Skripts zur Umwandlung der JSON-Ausgabe in eine Markdown-Datei.
|
|
|
|
- Das Skript liest solc-output.json und extrahiert relevante Informationen.
|
|
|
|
- Generierung von strukturiertem Markdown-Text, der Folgendes enthält:
|
|
|
|
- Benutzer-Dokumentation (Methoden, Beschreibungen, Parameter, Rückgabewerte)
|
|
|
|
- Entwickler-Dokumentation (Fehler, Events, detaillierte Methodenbeschreibungen)
|
|
|
|
- Speicherung des generierten Markdown-Textes in Contract.md im docs-Verzeichnis.
|
|
|
|
|
|
|
|
## Anzeige der Markdown-Datei als Webseite mit MkDocs
|
|
|
|
|
|
|
|
1. Installation von MkDocs
|
|
|
|
2. Projekt erstellen
|
|
|
|
3. Konfiguration in mkdocs.yml
|
|
|
|
4. Dokumentation hinzufügen: Verschieben der generierten Contract.md in das docs-Verzeichnis
|
|
|
|
5. Lokale Vorschau starten
|
|
|
|
6. Erstellung der statischen Seite
|
|
|
|
7. Optionales Deployment auf GitHub Pages
|
|
|
|
|
|
|
|
## Vorteile der Verwendung von MkDocs
|
|
|
|
|
|
|
|
- Einfache Bedienung und Konfiguration
|
|
|
|
- Unterstützung von Themes für professionelles Aussehen
|
|
|
|
- Integrierte Suchfunktion
|
|
|
|
- Verwaltung mehrerer Seiten
|
|
|
|
- Einfache Navigation zwischen Dokumenten
|
|
|
|
|
|
|
|
## Schlussfolgerung
|
|
|
|
|
|
|
|
Dieser Prozess ermöglicht die Erstellung einer gut strukturierten, lesbaren und wartbaren Dokumentation für Smart Contracts. Die Verwendung von Markdown als Zwischenformat bietet Vorteile bei der Versionskontrolle und Flexibilität bei der Anzeige. MkDocs transformiert die Dokumentation in eine ansprechende, navigierbare Website, die für Entwickler und Benutzer gleichermaßen nützlich ist. |
|
|
\ No newline at end of file |
