Javadoc for C++

[buskmann]

En ting jeg liker veldig godt med Java, er at det er veldig enkelt å utarbeide dokumentasjon av filene i prosjektet. Til det bruker jeg Javadoc.

 

Finnes det noe liknende til C++?

[A_N_K]

Doxygen

[Peter]

Doxygen

Med doxygen kan du faktisk bruke samme syntax som du bruker i Javadoc

[Dovrebanen]

Doxygen fungerer finfint, men er det mest naturlig å plassere dokumentasjonen i header- eller source-filer?

 

Jeg holder en knapp på source ...

[Feynman]

Går an å dokumentere begge funksjonene. Kan være nyttig å f.eks. dokumentere en variabel som skal brukes av andre moduler og som derfor ligger .h-filen. Ellers er det vel mest naturlig å dokumentere den implementerte funksjonen, og ikke prototypen i .h-filen. Syns du ikke?

[Peter]

Spørs litt hva slags dokumentasjon det er snakk om. Etter min mening så skal en godt utviklet klasse kunne brukes uten at man vet hva som ligger bak, og da er det naturlig å bare dokumentere funksjonensdeklarasjonen.

 

Men for egen del, dersom man har mye/store klasser osv, så kan det jo være smart å dokumentere en del mer, og dette gjøres selvsagt gjerne i definisjonen.

[dayslepr]

jeg prioriterer dokumentasjon av interfacet.. for brukeren er vel en brukermanual der det står hvordan TVen fungerer på innsiden mindre interesannt, eller av mindre praktisk betydning