Best Practice Api docu

[tanzverfuehrung]

Hallo...also meine Firma und eine Hochschule haben eine Kooperation und wollen zusammen was Entwickeln. So ein Forschungsprojekt.
Mein Teamleiter ist leider in Urlaub und ich habe sowas noch nie gemacht.... soll nun eine kleine api doku schreiben, damit sie wissen wie sie ihre Software dann bei uns einbauen sozusagen.
Die Grundaufgabe heißt :"Beispiel und Doku für Hochschule anlegen "Wie man sich zum DeviceServer verbindet und ein Nachrichtenobjekt an den Service sendet""

Kann mir jemand Tipps geben, was da auf jedenfall rein gehört und was nicht???:rtfm:

 

[JavaMeister]

In der Aufgabe steht drin, was du schreiben sollst. Ansonsten ist das das Resultat von ständigen Foren posts mit 0 Eigeninitiative.

Also ich werde nicht die Aufgaben machen, für die du bezahlt wirst.

 

[tanzverfuehrung]

Traurige Welt...
Ich wollte sicher nicht das mir jemand meine arbeit macht...könnt ihr auch garnicht, weil ihr nicht den code habt.
Also ist deine aussage, leider ein wenig unsinnig.+ICh wollte bloß nichts vergessen und meinte mit tipp, was da rein kommt... was für uml diagramme da rein kommen oder ob die unwichtig sind...man man man
aber egal.schönen tag

 

[Joose]

Schau dir doch einfachmal die Java API Dokumentation an.
Was ist dort drinnen? Was findest du überflüssig? Was fehlt dir?

 

[tanzverfuehrung]

kann mir jemand ein plugin sagen was für eclipse ist, woraus ich mir die API docu erstellen kann?

 

[Joose]

Warum brauchst du dafür ein Plugin?

Kommentiere deine Klassen und Methoden mit Java-Doc /** [KOMMENTAR] */ und fertig.
Das Ganze kannst du einfach exportieren.

 

[tanzverfuehrung]

ja ich meine das exportieren...einfach "generate Javadoc" ja?

java doc besitze ich schon..

 

[Joose]

Ja in Eclipse
Rechte Maustaste auf dein gewünschtes Projekt -> Export -> im Dialog dann Java/Javadoc auswählen -> gewünschte Einstellungen vornhemen und fertig

 

[JavaMeister]

Traurige Welt...

Stimme ich dir voll und ganz zu: Meine "Eigeninitiative" Keule wird KONSEQUENT überlesen, und dann das:

kann mir jemand ein plugin sagen was für eclipse ist, woraus ich mir die API docu erstellen kann?

Das meine ich. Wenn man alle seine Fragen von anderen Beantworten lässt, weil es EZ PZ ist und es immer Help-Vamps geben wird, kommt so eine Leistung bei raus. - Wie würdest du diese einschätzen?

---
Edit: Und bevor Du hierdrauf antwortest mit "traurige welt" u.s.w. und wie sinnlos doch andere Postings sind. Versuche mal dich selber zu reflektieren und nimm dies als gut gemeinten Rat in direkter Ansprache zu nehmen. Klar ist meine Formulierung "streng" und ohne Blümchenfilter, wenn man darin jedoch was anderes als einen Rat interpretiert, liest meine Postings falsch.

 

[tanzverfuehrung]

ich weiß nicht was so schlimm ist, wenn man auch mal einfache sachen fragt.
Wenn ich sie noch nicht gemacht habe, kann ich sie nun mal noch nicht wissen.
Und wenn dir meine frage zu primitiv ist, dann verschwende doch einfach nicht deine und meine zeit und antworte so ein mist.Danke

 

[tanzverfuehrung]

danke