7301 dokumentation

Pseudokod

  läs in tal
  om tal är 11
      skriv ut: rätt
  annars
      skriv ut: fel

Flödesschema

Kod

  tal = input("ange heltal")
  # omvandla till heltal från text
  tal = int(tal)
  if tal == 11:
      print("rätt")
  else:
      print("fel")

Kommentarer i koden föregås av #.

Skriv kommentarer för att förklara det som inte är uppenbart.

Självdokumenterande kod

Om variabler och funktioner m.m. ges beskrivande namn så kan behovet av kommentarer minskas.

Variabelnamnet skostorlek är bättre än x för att spara skostorlek.

Variabelnamn blir oftast substantiv och funktionsnamn blir oftast verb.

Kommentera funktioner

  def är_udda(tal):
      """Kontrollera om bifogat tal är udda. 
      Returnerat true om det är udda, false annars."""
      return tal % 2 == 1

I Python bör raden efter funktionshuvudet innehålla en beskrivning av vad funktionen gör samt vilka argument den tar och vilket svar den lämnar. Trippla citationstecken används runt kommentaren. Kommentaren kan delas upp på flera rader.

I funktionsdefinitionen kan det finnas vanliga kommentarer också som föregås av #.