genofire/hs_monolith
genofire
/
hs_monolith
Archived
1
0
Fork 0
This repository has been archived on 2020-09-27. You can view files and clone it, but cannot push or open issues or pull requests.
hs_monolith/KSS-Dokumentation/Doku_Microservice_Warenwirt.../Kapitel/Implementierungsregeln.tex

17 lines
902 B
TeX

\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}