BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2026-01-12 11:40:02 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

edit _gen/readme

Browse source
This commit is contained in:
Bastian Schroll 2018-01-04 23:40:21 +01:00
parent 7182e40b7b
commit 864b168e20
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
_gen/readme.md
View file

@ -1,9 +1,9 @@
## Generatoren
Im Verzeichniss _gen befinden sich Windows Batch-Scripte um bestimmt Aufgaben zu
vereinfachen und automatisieren.
Im Verzeichnis `_gen/` befinden sich Windows Batch-Scripte um bestimmt Aufgaben zu
vereinfachen und zu automatisieren.
### cloc.bat
CLoC steht für Count Lines of Code
CLoC steht für `Count Lines of Code`
Dieses Tool erstellt einen kurzen Report über die Anzahl der Dateien, Codezeilen,
Kommentare und Leerzeilen sortiert nach jeweiliger Programmiersprache
@ -13,9 +13,9 @@ Kommentare und Leerzeilen sortiert nach jeweiliger Programmiersprache
Doxygen ist ein Dokumentationswerkzeug zum automatischen dokumentieren von Quellcode.
Nach dem ausführen wird der gesamte Quellcode geparst und eine HTML Dokumentation
im Verzeichnis "_docu/html/" angelegt.
im Verzeichnis `_docu/html/` angelegt.
Die Konfigurations Datei für Doxygen findet sich unter "_config/doxygen.ini"
Die Konfigurations Datei für Doxygen findet sich unter `_config/doxygen.ini`
### pytest.bat
@ -23,18 +23,18 @@ pytest ist ein Python Testframework
Damit ist es möglich, automatisierte Tests laufen zu lassen.
Nach dem Start kann man mit einem Druck auf [ENTER] direkt alle bekannten Tests
Nach dem Start kann man mit einem Druck auf `[ENTER]` direkt alle bekannten Tests
laufen lassen, oder durch die Eingabe eines spezifischen Tests auch nur diesen
ausführen. Die Tests werden dabei in zufälliger Reihenfolge abgearbeitet um auch
Fehler durch Abhängigkeiten voneinander zu erfassen.
Die Testfälle befinden sich im Unterordner "test"
Einzeltests werden durch Eingabe des Namens ohne "test_" und ".py" aufgerufen.
Zum Beispiel "decoder" statt "test_decoder.py"
Die Testfälle befinden sich im Unterordner `test/`
Einzeltests werden durch Eingabe des Namens ohne `test_` und `.py` aufgerufen.
Zum Beispiel `decoder` statt `test_decoder.py`
Zusätzlich werden alle Quellcode Dateien mittels eines PEP8 Parsers auf die Einhaltung
der Code-Sytel Vorgaben von Python hin untersucht und etwaige Fehler ausgegeben.
Vom Testverlauf wird ein Logfile erstellt welches in "log/test.log" befindet.
Vom Testverlauf wird ein Logfile erstellt welches in `log/test.log` befindet.
Die Konfigurationsdatei für pytest findet sich unter "_config/pytest.ini"
Die Konfigurationsdatei für pytest findet sich unter `_config/pytest.ini`