From 9d403f2400cce1a32d8708cd12ec80e6bd6e2711 Mon Sep 17 00:00:00 2001 From: mlabusch Date: Fri, 30 Jun 2017 14:22:13 +0200 Subject: [PATCH] [Task] Add Documentation --- .../chapter/Implementierungsregeln.tex | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 documentation/microservice_stock/chapter/Implementierungsregeln.tex diff --git a/documentation/microservice_stock/chapter/Implementierungsregeln.tex b/documentation/microservice_stock/chapter/Implementierungsregeln.tex deleted file mode 100644 index 708ea7b..0000000 --- a/documentation/microservice_stock/chapter/Implementierungsregeln.tex +++ /dev/null @@ -1,12 +0,0 @@ -\section{Implementierungsregeln} -\label{sec: Implementierungsregeln} -Die folgende Aufzählung gibt einige Regeln für die Implementierung des Microservice Warenwirtschaft vor. Diese sollen 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 ein- bis zweizeiliger, beschreibender Kommentar, der die Hauptfunktionalitäten wiedergibt - \item Vor jeder Funktion steht ein ein- bis zweizeiliger, beschreibender Kommentar, der die Hauptfunktionalitäten wiedergibt -\end{enumerate} -