genofire/hs_monolith
genofire
/
hs_monolith
Archived
1
0
Fork 0
Code Releases Activity

[Task]: Completing the Dokumenation for more Information

This commit is contained in:
mlabusch 2017-04-28 09:21:43 +02:00
parent 67725d3ed4
commit c15ad380af
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/Implementierungsregeln.tex
View File

@ -1,2 +1,16 @@
\section{Implementierungsregeln} \section{Implementierungsregeln}
\label{sec: 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}