Citat:
Ursprungligen postat av Stoltz
Jag är alltid övernoga (kanske, min arbetslivserfarenhet inom branschen är inte så hög ännu) med att döpa mina variabler och funktioner på sätt som är lättförstådda och intuitiva.
En array med object som innehåller datum och omsättning t.ex. har ofta variabelnamn likt "dateAndRevenueObj_array" och själva objekten vid skapning har variabelnamnet "dateAndRevenue_object".
Det ska inte vara svårt att komma ihåg vad det är för variabel/funktion man jobbar med, och vad det är för typ (om inte kodspråket har automatiskt stöd för att visa det dvs) och so far har det verkat uppskattat
|
Målet är ju att man skall kunna läsa koden lika lätt som prosa.
Själv är jag tveksam till att lägga till typen till variabelnamnet. Av erfarenhet så vet jag att man lätt ändrar typ på en variabel och så glömmer någon att uppdatera variabelnamnet.
T.ex. Man kanske börjar med
TransactionVector eftersom det är transaktioner som sparas i en vektor. Men sedan är någon inne i koden och pillar och byter ifrån vektortyp till någon annan form av kontainer, men utan att ändra variabelnamn. Och så sitter man där med skägget i brevlådan igen när man inte begriper varför
TransactionVector inte beter sig som en vektor.
De flesta IDE har ju idag stöd för att visa variabeltyp när man hovrar över variabelnamnet, så jag försöker döpa mina variabler utan att nämna variabeltyp. Så i ovan exempel så hade det väl blivit något mer generellt i stil med
TransactionContainer.
Det enda som jag fortfarande envisas med, är att ange vilka variabler som är medlemsvariabler. Men även detta kan ju ses som tveksamt med tanke på det stöd som finns i dagens IDE:er.