Code-Kommentare aus Dateien rausziehen und als Code Annotations darstellen
Als Entwickli will ich Code Kommentare herausziehen und so umbauen, dass sie in der Dokumentation als Code Annotations dargestellt werden können.
Möglicher Ablauf:
- File, z.B. ein
.yml-File scannen - Alle Kommentare rauskopieren
- Kommentare automatisiert durchnummerieren
- In das File entsprechende Zahlen einsetzen
Mehr Informationen zu Code Annotations hier: https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations. GGf. könnte dafür ein Macro erstellt werden: https://mkdocs-macros-plugin.readthedocs.io/en/latest/
DoD
-
Macro zur Erstellung von automatisierten Code Annotations erstellt -
Review einer zweiten Person durchgeführt