Hur dokumentera pa bästa sätt?

Java

3 svar · 310 visningar · startad av jepsO

Medlem sedan mars 2001484 inlägg
Trådstart#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 :).

Medlem sedan juni 20008 205 inlägg
Medlem sedan mars 2001484 inlägg
#3

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

Medlem 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.

265 ms totalt · 4 externa anrop · v20260731065814-full.d34c6d5a
125 ms — deklarationer (db)
0 ms — hämta statistik (cache)
137 ms — hämta tråd, inlägg och bilagor (db)
124 ms — ändringar (db)