Notifikationer

Markér alle som læst Log ud

madrich Nybegynder

25. januar 2002 - 02:29 Der er 2 kommentarer og
1 løsning

Dokumentation på dokumentation!

Yo up!

Jeg skal til at dokumentere en ASP løsning, Jeg har udviklet, men mangler lidt info på hvilke parametre jeg skal dokumentere og i hvilken grad.

Har selvfølgelig lavet Dokumentation af de mere komplekse funktionaliteter, og lidt på brugerfladerne, men mener ikke selv at min dokumentation er så struktureret som min kode.;)

Det jeg leder efter er konstruktive råd bakket op af heftige link, og/eller evt. bog referencer der kunne være fede at tage udgangspunkt i.

Synes godt om

nephilim Nybegynder

25. januar 2002 - 04:47 #1

prøv at kigge på javadoc dokumentationen som bruges på java kode, den er meget fyldestgørende. du kan prøve at se hvordan den er lavet på
http://java.sun.com/j2se/1.4/docs/api/index.html

Synes godt om

sylvester1 Nybegynder

25. januar 2002 - 13:27 #2

Når jeg plejer at dokumentere, så gør jeg det meget enkelt. Jo enklere det er, jo lettere er det at sætte sig ind i det, hvis koden skal overdrages til en 3. person..

eks.:

<%
' Oprettelse af ADODB-dataobjektet
set conn = server.CreateObject("ADODB.CONNECTION")

' Åbning af databaseforbindelsen
Conn.Open "DRIVER={Microsoft Access Driver (*.mdb)}; DBQ=" & Server.MapPath ("\musikliv.mdb")

%>

... Og så videre...

Det er det som de fleste vil have... Du behøver ikke at beskrive hvert eneste parameter.. Kun hvad du gør..

Synes godt om

nephilim Nybegynder

29. januar 2002 - 05:49 #3

takker

Synes godt om

Ny bruger Nybegynder

Din løsning...

Tilladte BB-code-tags: [b]fed[/b] [i]kursiv[/i] [u]understreget[/u] Web- og emailadresser omdannes automatisk til links. Der sættes "nofollow" på alle links.

Følg dette spørgsmål

Opret Preview

Programmeringssprog kurser

Kurser inden for grundlæggende programmering

Se alle Programmeringssprog kurser

Flere spørgsmål fra ASP kategorien

Titel	Indlæg	Oprettet	Seneste aktivitet
ASP classic kopiere database fil på server Af bsn i ASP	7	31/10/202610:20	01/11/202620:28
Persits.Upload Af bsn i ASP	9	17/09/202611:37	21/09/202615:15
Jeg bakser med noget Database og If Then med ASP - hvad gør jeg galt? Af Peer i ASP	10	25/06/202622:20	04/09/202602:30
Tjek alle checkbox i form Af bsn i ASP	4	18/05/202601:57	19/05/202613:33
Lost focus Af bsn i ASP	1	07/11/202415:34	01/01/202514:58

Se alle spørgsmål i kategorien Opret spørgsmål

Log ind eller opret profil

Hov!

For at kunne deltage på Computerworld Eksperten skal du være logget ind.

Det er heldigvis nemt at oprette en bruger: Det tager to minutter og du kan vælge at bruge enten e-mail, Facebook eller Google som login.

Du kan også logge ind via nedenstående tjenester

Alle kategorier på Eksperten

Seneste artiklerRSS