PDAT01 - 2122 - 1. Commentaar

• Communication & multimedia design
• HBO
• Studiejaar 2

Python Commentaar

Ik wil het vandaag met jullie gaan hebben over.....

* Hoe je commentaar in python code gebruikt,
op twee manieren:

1. inline

2. multi line

# Commentaar

Het is bij het programmeren heel belangrijk om te weten hoe je commentaar tussen je code schrijft. 

Met commentaar kun je je contactgegevens achterlaten, maar je kunt ook uitleg geven bij code, of code tijdelijk 'uit' zetten - het wordt dan niet geëvalueerd (uitgevoerd)

Zet een # vooraan de zin, of gebruik '''(drie enkele knopen)'''

lees meer

https://www.w3schools.com/python/python_comments.asp

Waarom Commentaar?

Als we python gebruiken, schrijven we instructies voor de computer. Dat moet dus in een taal die de computer begrijpt. Voor mensen is het alleen minder goed te begrijpen. 

Door commentaar bij je code te plaatsen maak je het makkelijker voor mensen om je code te begrijpen.   

Waarom Commentaar?

• Zodat mensen weten wie de code geschreven heeft en wie ze kan helpen als ze het niet begrijpen.
• Zodat anderen je code begrijpen.
• Zodat je later zelf je code ook nog begrijpt.
• Zodat je je sneller kunt oriënteren in het document en dus sneller kunt navigeren
• Zodat er een backlog is van veranderingen of wensen

Oriënteren = weten waar je bent

Navigeren = van de ene plek naar de andere bewegen

backlog = een logboek entry

Meer informatie

Van GMDers wordt verwacht dat zij (een beetje) kunnen programmeren en dat zij zich een nieuwe taal zelfstandig eigen kunnen maken met behulp van online documentatie (die vaak in het Engels is)

Oefen jezelf er daarom in om te zoeken naar uitleg met Google. 

Er zijn verschillende goede sites, maar wij zullen vaak linken naar W3Schools met dit symbool:

Python

https://www.w3schools.com/python/default.asp

tip: Bij W3Schools vind je veel voorbeelden die je in de browser kunt uitproberen en aanpassen. 

Zo leer je snel hoe de code werkt!

Python Comments

https://www.w3schools.com/python/python_comments.asp

Er zijn 2 soorten commentaar

inline comments

multiline comments

• Beslaan meerdere regels
• Kunnen niet na code komen die wordt geëvalueerd

# Dit is commentaar

x = 5      # en dit is commentaar

print('dit wordt uitgevoerd')

""" dit is commentaar

over meerdere regels """

'''en het kan ook met single quotes '''

Syntax: Plaats een # (hashtag) voor je commentaar

Syntax: 3 single of double quotes voor én na je commentaar

• Zijn 1 regel of korter
  
• Kunnen na code voorkomen die wél wordt geëvalueerd.

Python Comments

https://www.w3schools.com/python/python_comments.asp

Welk leesteken moet je vóór commentaar typen?

1. @
2. $
3. %
4. #

Hieronder staan correcte voorbeelden van hoe je commentaar kan geven in Python. Categorizeer ze:

inline Comments

Multi Line Comments

#Dit is commentaar

x = "code die wordt uitgevoerd"

x = 25      # en dit is commentaar

# Onderstaande code is uitgecommentariëerd

# mystring = "code die wordt uitgevoerd"

# myvar = 25

""" Deze voorbeeldcode is gemaakt door

Cheryl Van Kempen

@ Aeres Hogeschool """

''' triple single quotes kunnen ook '''

Met welke tekens kun je een Multi Line Comment in Python schrijven?

Kies alle juiste antwoorden

1. """ triple double quotes """
2. '''triple single quotes '''
3. (plaats het tussen haakjes)
4. [plaats het tussen rechte haken]

Welke code klopt?

1. @ dit is commentaar
2. "" dit is commentaar
3. # dit is commentaar
4. ! dit is commentaar

Waar is het Python commentaar fout ingevoerd? gooi die weg

Fout

#Dit is commentaar

x = "code die wordt uitgevoerd"

x = 25      # en dit is commentaar

# Onderstaande code is uitgecommentariëerd

# mystring = "code die wordt uitgevoerd"

# myvar = 25

""" Deze voorbeeldcode is gemaakt door

Cheryl Van Kempen

@ Aeres Hogeschool """

% dit is commentaar

x = 5.5

x = 25, en dit is commentaar

$ Onderstaande code is uitgecommentariëerd

$ mystring = "code die wordt uitgevoerd"

$ myvar = 25

'' Deze voorbeeldcode is gemaakt door

Cheryl Van Kempen

@ Aeres Hogeschool ''

''' triple single quotes kunnen ook '''

' single quotes kunnen ook als comment '

Waar staat het python commentaar goed ?

Kies alle juiste antwoorden

1. \comment
2. # mijn commentaar
3. "mijn commentaar
4. """ mijn commentaar """

Je wil dat er een stuk code geëvalueerd wordt en op dezelfde regel wil je commentaar plaatsen. Plaats ze in de juiste volgorde:

naam = input('je naam?')

# bewaart de naam

Je hebt verschillende codes uitgeprobeerd. Plaats de hashtag voor de code die fout is. 

x = input ('hoe heet je?

x = input ('hoe heet je?')

#

Schrijf de volgende tekst in multi-line comment: "Ik kan python commentaar schrijven"

Schrijf de volgende zin als python commentaar:
"dit is commentaar"

Je hebt al een stukje code en daarachter wil je commentaar plaatsen. Hoe schrijf je dat in python? (gebruik 4 spaties)

x=3.5 commentaar

Open Spyder of W3schools en probeer de verschillende commentaren uit. Plak je uiteindelijke code hieronder

Python Comments

https://www.w3schools.com/python/python_comments.asp

Python Comments

https://www.w3schools.com/python/python_comments.asp

Wat heb je deze les geleerd?

Waar zou je meer uitleg over willen?