From c15ad380af5ff0af3a90d4e409a4cf0260385412 Mon Sep 17 00:00:00 2001 From: mlabusch Date: Fri, 28 Apr 2017 09:21:43 +0200 Subject: [PATCH] [Task]: Completing the Dokumenation for more Information --- .../Kapitel/Implementierungsregeln.tex | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/Implementierungsregeln.tex b/KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/Implementierungsregeln.tex index 7b9d4df..d6eee84 100644 --- a/KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/Implementierungsregeln.tex +++ b/KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/Implementierungsregeln.tex @@ -1,2 +1,16 @@ \section{Implementierungsregeln} \label{sec: Implementierungsregeln} +Die folgende Aufzählung gibt einige Regeln für die Implementierung des Microservice Warenwirtschaft vor. Diese sollten im Rahmen einer Weiterentwicklung eingehalten werden, um die Konsistenz des Codes aufrecht zu erhalten. + +\begin{enumerate} + \item Packages werden eindeutig und sprechend benannt + \item Go-Files werden eindeutig und sprechend benannt + \item Wenn ein Package nur ein Go-File enthält, erhält dieses den Namen seines Packages + \item Vor jedem Package steht ein einzeiliger, beschreibender Kommentar, der die Hauptfunktionalitäten wiedergibt + \item Vor jeder Funktion steht ein zweizeiliger, beschreibender Kommentar, dieser enthält + \begin{enumerate} + \item eine einzeilige Beschreibung der Funktionalität + \item eine einzeilige Beschreibung der Eingabe- und Rückgabewerte + \end{enumerate} +\end{enumerate} +