Just nu i M3-nätverket
Jump to content

Dokumentation av hemsida


.mixon

Recommended Posts

Hej,

 

jag undrar om det finns några speciella riktlinjer eller någon standard för hur man ska dokumentera en hemsida.

 

mixon

Link to comment
Share on other sites

Ja det var kanske aningen luddigt formulerat :)

 

Jag ska lämna min post här på jobbet och då jag är den enda som vet hur vår hemsida är uppbyggd så vill jag på något enkelt sätt strukturera upp och beskriva hur den är konstruerad.

 

Link to comment
Share on other sites

  • 1 year later...

 

Hej

 

sitter och läser detta gamla inlägg.

 

Jag undrar hur det gick ?

 

Fick du veta något om hur man ska "dokumentera"

 

webbsidan ?

 

 

 

Link to comment
Share on other sites

Alla programmerare har väll sina sätt att dokumentera sin kod. En del är sparsamma, en del dokumenterar inte. En del passar på att lägga in sin frustration i form av kommentarer : )

 

Har inte erat företag några riktlinjer?

 

Jag vet inte om eran sida är dynamisk eller statisk. Men det är ett gott råd att kommentera funktioner. Ex:

 

'Hämta det aktuella dagsvärdet.

dayVal = getVar(get)

 

exemplet ovan kommenterar ett anrop till en funktion. Så att den som läser koden vet vad som händer.

 

Skulle kunna tänka mig att många programmerare håller med mig då jag säger:

Hellre fler kommentarer än för få.

 

Det är inte kul att gå igenom kod som innehåller "dumma" variabelnamn och märklig Ooptimerad kod utan kommentarer.

 

Hoppas svaret hjälpte och att det var detta du menade med dokumentation. En bilaga i form av någon fil (.doc?). som visar hur strukturen och anropen sker mellan sidorna är också uppskattat för den som senare ska läsa koden. En slags "karta" över hemsidan.

 

//MVH Mindsleep

 

*** The answer to knowledge is a question ***

 

Link to comment
Share on other sites

Archived

This topic is now archived and is closed to further replies.

×
×
  • Create New...