From 0b0d6fe81b8b7316c1236b4139d4870c1146b356 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Bj=C3=B6rk?= <ddbjork@gmail.com>
Date: Tue, 20 Dec 2016 14:37:36 +0100
Subject: [PATCH] SystemDesign: Code of conduct: naming, grouping, etc
---
chapters/systemDesign.tex | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/chapters/systemDesign.tex b/chapters/systemDesign.tex
index 4544579..f421603 100644
--- a/chapters/systemDesign.tex
+++ b/chapters/systemDesign.tex
@@ -1,5 +1,13 @@
\subsection{Code of Conduct}
- The code follows a simple code of conduct. This generally helps avoid variable naming collisions and other issues which may result in undefined behavior.
+ The code follows a simple code of conduct. This generally helps avoid variable naming collisions and similar issues which may result in undefined behavior. With much consideration to simplicity in development it has been kept limited to resolve the most important code structuring issues.
+
+ Each file of code contains a group of functions related to a specific functionality. To avoid memory leaks and overwriting data, every function and global variable in a file has a prefix, which is the same as the name of the file. Enabling a developer to easily follow the codeflow through files when coding or debugging.
+
+ The prefix must begin with a capital letter and variables and functions should begin with a lower case letter, unless it is an abbreviation, though this is discouraged.
+
+ Most of the functionality has to be initialized on boot before it can be used. The decision to make an \texttt{Prefix\_init()} function makes it easy to keep code flow and code names similar throughout the code.
+
+
\subsection{Static Design}
\subsubsection{Class Diagram}
--
GitLab