Programmeringsteknik

Teori

Att kommentera

Att namnge

Övningar

Kommentarer

# Skriv ut Charles ålder
print("Charles is")
age = 2012-1987
print(age, "years old")

Den första raden i det här programmet, raden som börjar med #-tecknet, är en så kallad kommentar. Raden påverkar inte vad som händer när man kör programmet utan är enbart avsedd som information för den som läser programmet. I Python räknas allt från och med #-tecknet till radslut som en kommentar.

Kommentarer kan kanske verka överflödiga men är i själva verket mycket viktiga för att man ska kunna förstå och överblicka sina program.

Funktion, klass, metod

def funktionens_namn(param1, param2):
'''<Kort kommentar/förklaring om vad funktionen gör>

param param1: <förklara inparametern>
param param2: <förklara inparametern>
returns: <returvärden>
'''

Exempel:

def calculate_c_and_f(degree, choice):
    """Converts temperatures between Celsius and Fahrenheit
    param degree: temperature in either C or F
    param choice: key to convert from C to F ('F') or F to C ('C')
    returns: temperature according to param choice
    """
    convert = {'F' : degree * 9/5 + 32,
               'C' : degree * 5/9 - 32}
    
    return convert[choice]