Java Dokumentations Applikation

Hvilke krav lever Javadoc ikke op til?

Folks Krav... (Mine fx)..

Tja... det kan vel hurtigt defineres til at det er så meget mere besværligt end at dokumentere C#... (Efter min mening)...

Igen så ved jeg heller ikke, men syns ikke jeg har set dokumentation i mange andre formater end til HTML og evt. PDF... her kan det jo være jeg tager fejl... men XML fx mm.

OG altid samme gamle layourt som i mine øjne simpelthen ikke gør jobet mere.
Jeg er mere Design orienteret end mange af mine "programmerings" budys... og ting skal være funktionelt og pænt på samme tid...

Jeg kan ikke se at Javadoc er så ringe, som du siger. Javadoc er lavet med et formål, hvilket jeg synes det opfylder meget godt, nemlig umiddelbar beskrivelse og forståelse af koden for programmøren. At du ikke oplever dig selv som hardcore programmør kan måske netop være årsagen til at du ikke bryder dig om Javadoc, men formålet har heller aldrig været at tilfredsstille grafiske krav af nogen art.

I mit professionelle arbejde anvender jeg med tilfredshed ofte Javadoc til at beskrive den kode jeg udvikler, samt Microsoft Visio til udarbejdelse af UML-diagrammer. Hvis du vil lave et genialt stykke værktøj, så laver du et modul til Visio, der kan generere Java-kode ud fra UML-diagrammer, og omvendt - men det får du næppe lov til :-)

Jeg synes ikke at kunne finde nogen helt saglige argumenter mod Javadoc i dine beskrivelser. Hvis Javadoc ikke er et værktøj der opfylder dine behov, må du naturligvis finde et andet, eller lave et nyt, men det betyder jo ikke, at Javadoc er dårligt, til det der er formålet med det. Du forlanger jo heller ikke af et komfur, at det holder mælken kold ;-)

Javadoc er den mest udførte refferance/manual jeg nogen sinde har set,
og derfor er den for svær at finde rundt i.

Som en java-nørd på irc engang sagde:

"Thats the problem with java, they documentet it to well"

Men ide'en er genialt.

dsj >

Må jeg spørge om du har benyttet andet end Java til noget i dit professionelle arbejde?

Du nævner Visio og at du gerne vil have Forward- og Reverse-Engenering til det sammen med java... Visio er nu et meget dårligt valg sammen med Java vil jeg som det første sige... der burde du måske overveje et andet værktøj...

Jeg bruger selv Visio til C#, og til Reverse-Engenering, og når du arbejder i Visual Studio er det næsten ikke mere end "tryk på en knap"... Det virker fint...

Men til Java skal du nok overveje andre veje... Nogle du måske kunne tage et kig på:
Borland Together: http://www.borland.com/products/downloads/download_together.html
Oracle JDeveloper: http://www.oracle.com/technology/products/jdev/index.html

Together har jeg ikke selv brugt, men det skulle understøtte de 2 ting du leder efter, det samme ved jeg JDeveloper gør, da jeg selv har prøvet det.

Jeg vil gerne lave en Applikation, og jo iden med at du kan Engenier og Reverse Engenier er da smart nok, En vision kunne vel også være Hvorfor ikke have det hele i et? et Program hvor du kan kode dit progra,. hvor du kan lave dokumentation til dine klasser, du kan benytte UML osv... Genial ide?... men måske det lige er at tage munden for fuld i første omgang...

Det jeg gerne vil have er noget der kan lave et Dokumentations API over ens klasser i en give applikation, og noget der gør det nemt for ham som lige er startet men Java, og noget som giver den erferende store muligheder for selv at bestemme hvordan netop han vil gøre tingene.

Grunden til jeg tidligere spurgte om du have benyttet andet end java til Professionelle opgaver var netop at jeg benytter mere C#, på skolebænken var det Java vi lærte, men i min fritid kastede jeg mig over C#. og det er der mine ærvelser over Java og JavaDoc starter... jeg ville bare gerne prøve at give folk der benytter Java nogle af de samme muligheder, startende med Dokumentationen...

morteeart >>>

Jeg syntes da ikke de er svære at finde rundt i???
Kan ikke helt følge dig der?
Det er da funktionelt godt opbygget af sin tid...

Jeg syntes da nærmere det er på tide at udvide horisonten.
Prø tag et kig på hvorden tingene er lavet på MSDN:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystem.asp

Se det syntes jeg er Smart, men jeg syntes desvære også at det er "FOR MEGET"...
Der burde de i mine øjne have adskilt tingene mere... fordi det netop er svært at finde rund i...

Men tilgengæld så indeholder det utrolig mange gode ting, som jeg syntes JavaDoc mangler... Så en slags mellem ting kunne måske være det målet var...

Jeg arbejder med mange andre sprog end Java og er meget bekendt med funktionerne i Visual Studio. Jeg har arbejdet med flere andre UML-værktøjer end Visio, men har ikke fundet nogen, der er lige så gode og anvendelige (et spørgsmål om smag) som Visio.

Jeg tager ikke munden for fuld - det jeg er lidt ude efter i min kommentar ovenfor er, at muligvis har vi brug for nye værktøjer, men jeg synes kritikken af Javadoc er uberettiget og usaglig - det gør hvad det er bestemt til, mere kan man heller ikke forlange. F.eks. synes jeg Javadoc hurtigere giver et langt bedre overblik end .NET's dokumentation.

Det er et spørgsmål om smag, hvorvidt man bryder sig om de forskellige værktøjer, men det retfærdiggør ikke nedrakningen af værktøjer på et usagligt grundlag.

dsj >>> Jeg kan ikke se at Kritikken er uberettiget når jeg netop fastslør at den er Subjektiv...

Jeg siger jo netop at JavaDoc fx Ikke lever op til MINE krav, og leder efter folk der har det på samme måde, så kan det kun være lidt svært for dig at komme og sige "Det passer ikke!"... for jeg ved nu bedst selv hvad der lever op til mine krav... at du så tilfældigvis syntes noget andet kommer jo SLET SLET ikke sagen ved..

Jeg står ikke og siger at JavaDoc er Skod, jeg står og siger JEG SYNTES JAVADOV ER SKOD... at du så syntes noget andet er jeg rimelig ligeglad med...

dsj >>>

For ligsom at sætte et stort fedt punktum her... og afslutte denne diskution om hvor vidt og hvorfor JavaDoc er godt eller skidt, som vi godt kan tage på et tidspunkt...

Vil jeg gøre dig opmærksom på at du har trådt helt forkert i denne tråd, for for at vende tilbage til sagens kerne... vil jeg Poientere et par ting denne tråd ikke gik ud på:

1 - At diskutere om JavaDoc er godt eller dåligt, samt hvorfor.
2 - At diskutere om du eller jeg kan argumentere.
3 - At svine Java eller JavaDoc til på nogen måde.
4 - At lave noget UML værktøj.
5 - At diskutere programmerings evner.

Men hvad gik den så ud på?

1 - At finde folk der delte mit synspunkt.
2 - At finde folk som havde gode ideer.
3 - At finde folk som var stærke i java.
4 - At finde folk som var interesseret i at skabe noget der kunne hjælpe andre.

lukker