webForumDet fria alternativet

Hur dokumentera pa bästa sätt?

3 svar · 305 visningar · startad av jepsO

jepsOMedlem sedan mars 2001484 inlägg
#1

Jag haller pa med ett relativt simpelt Java-projekt pa högskoleniva. Kraven är inte skyhöga, sa själva kodandet är inga problem.

Däremot skulle jag vilja passa pa att lära mig hur man dokumenterar pa ett bra sätt. Vilka standarder finns det för:
- löpande kommentarer i koden;
- information om klasser/interfaces/metoder;
- en extern dokumentation, dvs ett dokument med mycket mer utförlig information än den som finns i koden?

Ge gärna exempel om ni har nagot :).

spangoMedlem sedan juni 20008 205 inlägg
jepsOMedlem sedan mars 2001484 inlägg
#3

Naivt av mig att tro att Sun inte redan fixat nagot liknande :stud. Tack!

LimeMedlem sedan sep. 2001961 inlägg
#4

Det har dom inte... dom har "lånat" ett annat koncept... De lyckades bara få ut det brett genom att använda det själva för API:et.

129 ms totalt · 3 externa anrop · v20260731065814-full.86db40fa
0 ms — hämta forumlista (cache)
0 ms — hämta statistik (cache)
125 ms — hämta tråd, inlägg och bilagor (db)