From cbd19301ee92ed4db0c5abae4bb1886ab18d4198 Mon Sep 17 00:00:00 2001 From: Cem Keylan Date: Mon, 14 Sep 2020 20:09:17 +0300 Subject: update --- src/docs/General-Conventions.html | 79 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 src/docs/General-Conventions.html (limited to 'src/docs/General-Conventions.html') diff --git a/src/docs/General-Conventions.html b/src/docs/General-Conventions.html new file mode 100644 index 0000000..a75fca5 --- /dev/null +++ b/src/docs/General-Conventions.html @@ -0,0 +1,79 @@ + + + + + + +General Conventions (Carbs Linux User Manual) + + + + + + + + + + + + + + + + +
+

+Next: , Up: Conventions  

+
+
+

3.1.1 General Conventions – 00

+ +
+
[0010]
+

Try to keep the file readable. +

+
[0011]
+

Characters on a line shouldn’t exceed 100 characters. +

+
[0012]
+

Make sure you don’t have code commented out during commit. Uncomment them +or remove them completely. +

+
[0013]
+

Do not add comments following the code, add them to the top of the code. It +makes it harder to read, and lines longer. Here is an example: +

+
# Good way of commenting.
+your code goes here
+
+your code goes here  # Avoid this way of commenting.
+
+
+
+
+
+ + + + + + -- cgit v1.2.3