Dokumentation für (konfigurierbare) Regeln

HS-Flensburg-PLTP / jlint

Other

0 stars 0 forks source link

Dokumentation für (konfigurierbare) Regeln #359

Open mario-koehler opened 1 year ago

mario-koehler commented 1 year ago

Für die jlint-Regelkonfiguration sollte eine Dokumentation angefertigt und gepflegt werden. Diese sollte alle möglichen Regeln auflisten, ggf. mit optionalen/benötigten Parametern und kurzen Erklärungen dazu, sodass auch eine kompilierte Version verwendet werden kann, ohne den Quell-Code oder eine vollständige Beispiel-Config vorliegen zu haben.

jan-christiansen commented 1 year ago

Falls möglich sollte eine Schema-Definition für die YAML-Datei angegeben werden.