diff options
Diffstat (limited to 'src/docs/General-Conventions.html')
| -rw-r--r-- | src/docs/General-Conventions.html | 79 |
1 files changed, 79 insertions, 0 deletions
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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Licensed under Gnu Free Documentation License. --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>General Conventions (Carbs Linux User Manual)</title> + +<meta name="description" content="General Conventions (Carbs Linux User Manual)"> +<meta name="keywords" content="General Conventions (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="Conventions.html" rel="up" title="Conventions"> +<link href="Shell-Conventions.html" rel="next" title="Shell Conventions"> +<link href="Conventions.html" rel="prev" title="Conventions"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="General-Conventions"></span><div class="header"> +<p> +Next: <a href="Shell-Conventions.html" accesskey="n" rel="next">Shell Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> </p> +</div> +<hr> +<span id="General-Conventions-_002d_002d-00"></span><h4 class="subsection">3.1.1 General Conventions – 00</h4> + +<dl compact="compact"> +<dt><strong>[<span id="g_t0010"></span>0010]</strong></dt> +<dd><p>Try to keep the file readable. +</p><dl compact="compact"> +<dt><strong>[<span id="g_t0011"></span>0011]</strong></dt> +<dd><p>Characters on a line shouldn’t exceed 100 characters. +</p></dd> +<dt><strong>[<span id="g_t0012"></span>0012]</strong></dt> +<dd><p>Make sure you don’t have code commented out during commit. Uncomment them +or remove them completely. +</p></dd> +<dt><strong>[<span id="g_t0013"></span>0013]</strong></dt> +<dd><p>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: +</p><div class="example"> +<pre class="example"># Good way of commenting. +your code goes here + +your code goes here # Avoid this way of commenting. +</pre></div> +</dd> +</dl> +</dd> +</dl> + + + + +</body> +</html> |