Demomaker

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

---

General rules

1. Follow standard conventions.
2. Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
3. Boy scout rule. Leave the campground cleaner than you found it.
4. Always find root cause. Always look for the root cause of a problem.

Design rules

Demomaker

def pow_int(valueToPower, power):
    if not isinstance(valueToPower, int):
        return valueToPower
    resultingValue = 1
    if power > 0 :
        for i in range(0, power):
            resultingValue = valueToPower * resultingValue
    else :
        if power < 0 :
            for i in range(0, power):

Demomaker

def convert_int_to_scientific_notation(number):
    scientificSymbol = "x10^"
    decimalSeperationCharacter = '.'
    stringEquivalent = str(number)
    totalExponent = (len(stringEquivalent)-1)
    if ("" + decimalSeperationCharacter) in stringEquivalent :
        exponents = stringEquivalent.split(decimalSeperationCharacter)
        positiveExponent = exponents[0]
        negativeExponent = exponents[1]
        totalExponent = (len(positiveExponent)-1) - (len(negativeExponent)-1)

Demomaker

# This part of the file is used for imports (ex. import math)

# Use this to create one-liner comments
'''Use these to create multiline comments or one-liner comments. This is the preferred way'''

# This part of the file is used for creating functions (ex. def main())

'''This main function can be renamed to anything really
'def' establishes a function, main is the name of the function and () is an empty set of parameters
In Python, the usage of ':' is preferred over the usage of '{' and '}'.

Demomaker

def get4SquareNumber(n):
    if n == 1:
        return 0.25;
    return get4SquareNumber(n - 1) + 0.75 + 0.5 * (n-2);


def calculate2ndPower(n):
    return get4SquareNumber(n) * 4;

Demomaker

type anyType = IntElement of int | FloatElement of float | StringElement of string | BooleanElement of bool;;

let printStatement statement =
  let open Printf in 
  printf "%s" statement;;

let concatStrings string1 string2 =
  string1 ^ string2;;

let toString (x : anyType) =

Demomaker

%! This is a comment

splitString(String, SplitString) :-
    atom_chars(String, SplitString).

writeChars(Chars) :-
    foreach(member(X, Chars), writeChar(X)).

writeChar(Char) :-
    write(Char).

Demomaker

G0S 0A0 : Joly, Québec
G0S 0A1 : Laurierville, Québec
G0S 0A2 : Lotbinière, Québec
G0S 0A3 : Val-Alain, Québec
G0S 0A4 : Joly, Québec
G0S 0A5 : Saint-Gilles, Québec
G0S 0A6 : Saint-Édouard-de-Lotbinière, Québec
G0S 0A7 : Ste-Hénédine, Québec
G0S 0A8 : Dosquet, Québec
G0S 0A9 : Parisville, Québec