---
title: "Hur dokumentera pa bästa sätt?"
type: "forum-thread"
url: "https://www.webforum.nu/amne/java/103839-hur-dokumentera-pa-bästa-sätt"
topic: "Java"
topic_url: "https://www.webforum.nu/amne/java"
author: "jepsO"
published: "2004-05-18T10:33:24.000Z"
updated: "2004-05-18T11:52:05.000Z"
replies: 3
views: 310
page: 1
pages: 1
language: "sv-SE"
site: "webForum — webforum.nu"
rights: "Upphovsrätten till varje inlägg tillhör dess författare."
attribution: "Citera som: webForum, https://www.webforum.nu/amne/java/103839-hur-dokumentera-pa-bästa-sätt"
---

# Hur dokumentera pa bästa sätt?

## #1 — jepsO, 2004-05-18T10:33Z

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 :).

Permalänk: https://www.webforum.nu/p/103839

## #2 — spango, 2004-05-18T10:47Z

<http://java.sun.com/j2se/javadoc/> och framför allt <http://java.sun.com/j2se/javadoc/writingdoccomments/>

Permalänk: https://www.webforum.nu/p/1350547

## #3 — jepsO, 2004-05-18T11:34Z

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

Permalänk: https://www.webforum.nu/p/1350579

## #4 — Lime, 2004-05-18T11:52Z

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.

Permalänk: https://www.webforum.nu/p/1350591

---

Tråden på webben: https://www.webforum.nu/amne/java/103839-hur-dokumentera-pa-bästa-sätt