Fif

Her er nogle gode råd ud i din Python-rejse.

# -*- coding: utf-8 -*-

# -*- coding: utf-8 -*-

Denne kode er ikke en kommentar, selvom man skulle tro det ud fra pound-karakteren(#). Den siger kort og godt til Python, at den skal læse unicode-8. Det har vi som danskere ofte brug for, når vi skriver æ, ø, å.

# Kommentarer

Brug altid kommentarer i dine koder. Selv ved de allermindste programmer, som måske kun fylder 2 linjer, er det en god idé, at gøre det til en vane. Det vil komme dig til gode, når du senere skal skrive programmer med mange linjer.

Kommentarer kan enten skriver ovenfor en kode. Fx:

# Denne kode printer “Hejsa” ud.

print(“Hejsa”)

Du kan også skrive flere kommentarer efter hinanden. Fx:

# Denne kode er skrevet af Atle Winther d. 3.3.20.

# Koden printer “Hejsa” ud.

print(“Hejsa”)

Og du kan skrive kommentarer ude i siden. Fx.

print(“Hejsa”) #Printer “Hejsa

Et smart, synes jeg selv, trick jeg har set de gør på Havard, er at skrive en sidekommentar med en symbolsk pil der peger hen imod koden, således: #<- sidekommentar.

Docstrings

Docstrings er strings, som vi laver i koden. Enten i en funkton eller i en klasse.

En docstring fortæller brugeren, hvad programmet gør.

def g(h, g):
    """
    

    Parametrer
    ----------
    h : float
        Højden. Angiv højden på den retvinklede trekant
    g : float
        Grundlinjen. Angiv grundlinjen på den retvinklede trekant.
    
    Funktionen
    ----------    
    def g(200.56, 70):
        0.5 * h * g

    Eksempel
    -------
    g(h, g)
    
    g(8, 5.55)

    """
    # Returner værdierne h og g.
    return 0.5 * h * g

En docstring er altså i modsætning til en kommentar noget som vises for brugeren. Ved at taste help-funktionen vil man se funktionens docstring.

Man bestemmer selv, hvordan ens docstring skal se ud, men du kan eventuelt benytte denne skabalon:

 """
    
    Parametrer
    ----------
    h : TYPE(str, int, float)
        Skriv lidt om h.
    g : TYPE(str, int, float)
        Skriv lidt om g.
    
    Funktionen
    ----------    
    def g(200.56, 70):
        0.5 * h * g

    Eksempel
    -------
    g(h, g)
    
    g(8, 5.55)

"""

Der er mange funktioner, som ikke viser hvordan de er bygget op, når man forsøger at læse om dem i help-funktionen. Jeg synes det er en god idé, at vise brugeren hvordan man har bygget sin kode op.