Kommentera kod
Hur ska man tänka när man ska kommentera sin kod för att den ska bli godkänd? Jag har fått rest på mitt arbete.
Fick du några kommentarer? Och hur ser din kod ut?
Ska kommentera denna. Jag skrev:
%[E]= Elatgang2 (G, d, s)
%Funktionen beräknar sträckan som bilen färdas i efter ett visst intervall
%värdet som väljs på intevallet lagras i vektorn V=G(i)
Jag får nog lämna det åt någon som använder matlab mer än jag gör.
Skriv koden och lägg den i en låda några dagar. Sen tar du upp den och det du inte förstår kommenterar du. Har koden skrivits rätt från början behövs inga kommentarer. Det vill säga om variabelnamn och funktionsnamn väljs på ett smart sätt då kommenterar koden sig själv.
Även om man skriver jättebra kod kan det vara bra att skriva en kort kommentar vad funktionen gör och hur den används längst upp i programfilen.
Kommentera heller inte för mycket. Finns ingen anledning att kommentera sådant som är självklart. Typ
//a=b*c
a=b*c;
(ovanstående var ju inte matlab-kod, men du förstår säkert vad jag menar)
MATLAB var länge sen men V borde bara bli en konstant som antar det sista värdet i G? Varför iterera igenom det?
EDIT:
Börja indentera riktigt också. Det ökar läsbarheten avsevärt.
while foo:
Do_stuff; (all kod som ska göras i while-loopen flyttas in för att enkelt visa vad det hör till)
end
Vad är G, d och s? Parameternamn kan vara en mindre mening bara det är tydligt vad det representerar. Finns olika skolor för hur parametrar namnges men man ska inte vara rädd för att ge långa parameternamn.
