/institutionen
/logo_Rattsmedicin.gif
/knapp_loggain.gif
/kurser
/grunder
/rattsmedicin
/logo_Rattsmedicin.gif
Standard filnamn
När det gäller standard för namngivning är den generella principen
att svenska namn skall användas genomgående. Specifikt svenska tecken
som å, ä och ö används inte. Använd alltid korrekt namngivning från
början då temporära namn tenderar att bli permanenta. Antal tecken
som används vid namngivningen av filer styrs av eventuella begränsningar
i gällande operativsystem. Filnamn skall endast bestå av gemener.
Standard för olika filtyper beskrivs nedan.
Grafikfiler
Olika grafiska filformat skall namnges med nedan specificerade ändelser.
För de fall nya typer av filformat används och dessa inte finns preciserade
nedan skall en ändelse användas som avspeglar namnet på filformatet.
GIF .gif
JPEG .jpg
BMP .bmp
PNG .png
Namnet på exempelvis en knapp ska i möjligaste mån på svenska spegla
knappens funktion, t ex "knapp_spara.gif".Standard i övrigt är:
Knappar knapp_xxxx.gif
Logotyper logo_xxxx.gif, logo_meny_xxx.gif
Bakgrunder bg_xxx.gif, bg_meny_xxx.gif, bg_intern_xxx.gif
Texter text_xxx.gif, text_copyright_xxx.gif
Övriga element element_xxx.gif
PHP-filer (eller vad vi nu skall ha)
För PHP-filer gäller principen att alla filer skall ha ändelsen
".php".
Namnet på filerna skall i möjligaste mån på svenska spegla sidans
funktion, t ex "logga_in.php" eller "visa_konto.php". Tänk dock på
att sidans placering i biblioteksstrukturen även säger någonting om
dess funktion. Namnet behöver därför inte vara en uttömmande förklaring
av funktionen. För olika filtyper gäller följande namnstandard:
Startsida för funktion index.php
Urvalssida lista_xxx.php
Presentationssida visa_xxx.php
Övriga sidor xxx.php
HTML-filer
För HTML-filer gäller att dessa alltid skall ha ändelsen ".html".
Namnet på filerna skall i möjligaste mån på svenska spegla sidans
funktion, t ex "nyheter.html". Tänk dock på att sidans placering i
biblioteksstrukturen även säger någonting om dess funktion. Namnet
behöver därför inte vara en uttömmande förklaring av funktionen. För
olika filtyper gäller följande namnstandard:
Startsida index.html
Navigeringssida nav_xxx.html
Övriga sidor xxx.html
Övriga filer
Övriga typer av filformat skall namnges med nedan specificerade
ändelser. För de fall nya typer av filformat används och dessa inte
finns preciserade nedan skall en ändelse användas som avspeglar namnet
på filformatet.
PDF Acrobat-filer .pdf
WAV Ljudfil .wav VIV
Animeringsfil .viv
MOV Animeringsfil .mov
Namnstandard databaser
En databas består vanligtvis av många komponenter som dessutom varierar
från projekt till projekt vilket gör att endast mer generella riktlinjer
kan ges beträffande namnstandard. Tabeller skall ha namn på svenska,
utan å, ä, och ö, och inte vara i konflikt med reserverade ord i databashanteraren.
Namnen ska kort spegla innehållet i tabellen.
Exempel anvandare, konto
Kolumner skall ha namn på svenska, utan å, ä, och ö, och inte vara
i konflikt med reserverade ord i databashanteraren. Namnet ska inledas
med ett prefix för tabellen och tecknet underscore. Prefixet ska vara
en förkortning, alternativ sammandragning av tabellens namn för att
lättare kunna härleda kolumnens innehåll.Exempel kto_namn (i tabellen
konto) anvprof_id (i tabellen anvandarprofil)
Standard källkod
Allmänt Använd korrekt notation och namngivning redan från start
eftersom temporära lösningar tenderar att bli permanenta. Kommentarer
skall användas sparsamt och endast där de bidrar till förståelsen
av koden, överkommenterad kod blir lätt otydlig. Kommentarer skall
skrivas på svenska.
ASP (eller vad vi nu skall ha) Följande regler gäller för ASP-kod:
1. Konstanter skall användas för all relevant information i projektet.
2. Lokala konstanter för färger, typsnitt etc. skall deklareras
först i filen för att underlätta underhåll.
3. Globala konstanter deklareras i include-filer som anropas från
de övriga filerna.
4. Parametertilldelning med Request.Form() görs en gång per sida,
och med fördel i början, detta för att ge bättre prestanda.
Variabler
För variabler gäller följande regler:
1. Skapa beskrivande variabelnamn som är sammansatta av subjekt
och attribut med formen subjektAttribut. Subjektet skrivs med gemener
och attributet med inledande versal. Exempel loginNamn, loginLosenord
2. I de fall där en variabel har ett unikt subjekt kan variabelnamnet
skrivas som ett ord i gemener. Exempel raknare
3. Variabelnamn skall i möjligaste mån skrivas på svenska. En fördel
med detta är att det är lätt att skilja objekt som tillhör utvecklingsmiljön
från objekt som tillhör den egna koden. Man skall dock prioritera
förståelsen av koden främst vilket kan leda till undantag.
4. Sessionsvariabler döps enligt regel 1. men med tillägget att namnet
skall föregås av projektets/tjänstens namn, åtföljande ord skrivs
med inledande versal. Detta för att undvika namnkollision i ett webbsystem
bestående av flera delprojekt och/eller flera tjänster.
Exempel internKontoNamn, externKontoNamn
Konstanter
För konstanter skall följande principer tillämpas: Skapa beskrivande
konstantnamn som är sammansatta av subjekt och attribut med formen
SUBJEKT_ATTRIBUT. Subjektet och attributet skrivs i versaler och åtskiljs
med understrykningstecken "_". Funktioner och subrutiner Beträffande
funktioner och subrutiner gäller följande regler:
1. Skapa beskrivande funktionsnamn som är sammansatta av subjekt
och verb med formen SubjektVerb. Både subjekt och verb skrivs med
inledande versal.
2. Använd aldrig globala variabler i funktioner. Användande av globala
variabler försvårar underhåll och återanvändning.
3. Funktionsblock definieras med
4. Unika funktioner skall endast förekomma på ett ställe i projektet,
antingen i den ASP-fil där den används eller i en include-fil.
5. Funktioner skall läggas sist i de ASP-filer där de definieras.