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

[Task] Add Documentation

This commit is contained in:
mlabusch 2017-06-30 14:22:13 +02:00 committed by GitHub
parent 7cc295dc18
commit 9d403f2400
1 changed files with 0 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
documentation/microservice_stock/chapter/Implementierungsregeln.tex
View File

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