Best Practice Wie speichert/Dokumentiert Ihr eure Programme?

cpt.Tomato

Mitglied
Hi,

mal eine Frage, die mir heute aufgekommen ist, als ich meinen Fortschritt und die verschieden Codes und Klassen die ich schon geschrieben habe Dokumentieren wollte.

Ich habe mir meinen Code von fertigen Programmen bei Python immer in Textdokumente abgespeichert. So kann ich wenn dieser Moment kommt:

AH! Sowas hab ich doch schonmal gemacht!

Einfach in meinen Dokumenten nachschauen, wie ich dieses oder jenes Problem schonmal gelöst habe. Ich finde bei Java, ist das durch die Klassen etwas schwieriger oder aufwändiger.

Daher wollte ich mal fragen, ob ihr fertige Programme oder ähnliches Dokumentiert, also den Quellcode und die Klassen oder speichert Ihr euch einfach die Projekte ab?

Gibts da eine smarte Möglichkeit oder mache ich mir da gerade einen zu dicken kopp?

LG
Der Captain
 

cpt.Tomato

Mitglied
Ah hab gerade gemerkt, dass man die Klassen auch per Drag and Drop auf den Desktop/Ordner ziehen kann, welche dann beim klicken geöffnet werden können und man den Quellcode lesen kann.

Das macht es mir natürlich einfacher.

LG
Der Captain
 

krgewb

Top Contributor
Ah hab gerade gemerkt, dass man die Klassen auch per Drag and Drop auf den Desktop/Ordner ziehen kann, welche dann beim klicken geöffnet werden können und man den Quellcode lesen kann.
Du meinst die Java-Dateien? In einer .java-Datei können mehrere Klassen sein. In dem Fall musst du aber beachten, dass du nur eine dieser Klassen als public deklarieren darfst.
 

mrBrown

Super-Moderator
Mitarbeiter
Ich habe mir meinen Code von fertigen Programmen bei Python immer in Textdokumente abgespeichert. So kann ich wenn dieser Moment kommt:
Python-Programme sind genauso wie Java-Programme sowieso Text-Dateien (zumindest der Code), was speicherst du da noch extra ab?

Daher wollte ich mal fragen, ob ihr fertige Programme oder ähnliches Dokumentiert, also den Quellcode und die Klassen oder speichert Ihr euch einfach die Projekte ab?
Jedes Projekt liegt als git-Repo irgendwo auf meiner Platte, und zu dem Projekt gehören die Klassen, andere Resourcen und Doku.
Irgendwie extra abgespeichert wird da nichts.
 

White_Fox

Top Contributor
Das Einzige, was ich separat speichere, sind Bibliotheken. Wenn ich etwas programmiere, daß mir das nochmal woanders nützen könnte (meist ist das offensichtlich), wird es gleich als externe Bibliothek geschrieben. Wenn der Das-hab-ich-doch-schonmal-gemacht-Moment kommt wird diese einfach wieder eingebunden.

Das Schlimmste, was dabei passieren kann, ist, daß ich eine Bibliothek nur ein einziges Mal im Leben verwende. Mit sowas kann ich gut leben, weitaus besser als wenn Code für eigentlich den gleichen Zweck redundant in verschiedenen Versionen in verschiedenen Projekten liegt. Bei solchem Chaos krieg ich Hörner und fange an, Feuer zu speien.

Sollte ich mal den Fall haben daß ich etwas nicht als Bibliothek geschrieben habe, wo es aber angebracht gewesen wäre, wird es Zeit für ein kleines Refactoring.
Und die Dokumentation gehört selbstverständlich ins Projekt/Bibliothek. Wozu gibt es sowas wie Javadoc? Oder Doxygen?

Gibts da eine smarte Möglichkeit oder mache ich mir da gerade einen zu dicken kopp?
Als ausgesprochener Nichtprogrammierer maße ich mir dazu einfach mal folgende Meinung an: Ja, tust du. :)
 

ocsme

Top Contributor
Also ich bin ein totaler Anfänger und weiß deswegen leider nicht wie man eigene Bibliotheken schreibt.
Doch ich schreibe solche Code Zeilen dann in eine eigene Klasse wie z. B. die Math Klasse in Java. Dann hab ich eine Klasse wo Berechnungen nur mit Zahlen vorgenommen werden wie z. B. Quersumme, Fakultät, etc. Rekursiv sowie auch iterativ.
Dann habe ich String, Array Klassen :)
Das Thema Dokumentation habe ich mir heute angeschaut und finde das in Java sehr gut gelöst :) man schreibt einfach ein Doc-Komment über
Code:
/**
...
*/
fügt alles hinzu und wirft den javadoc-Compiler an :) auch sehr nett :)

Ansonsten habe ich das gleiche Chaos wie alle anderen auch :D
 

White_Fox

Top Contributor
Also ich bin ein totaler Anfänger und weiß deswegen leider nicht wie man eigene Bibliotheken schreibt.
Bei mir: Datei -> Neues Projekt -> Java Class Library auswählen. :)

Das Thema Dokumentation habe ich mir heute angeschaut und finde das in Java sehr gut gelöst :)
Dann beachte aber auch die Konventionen, die es noch dazu gibt. Diese Dokumente werden am Besten nach einem bestimmten Schema aufgebaut.
 
Ähnliche Java Themen
  Titel Forum Antworten Datum
Z Java ArrayList speichert falsche Daten ab bzw. gibt falsche Daten aus? Java Basics - Anfänger-Themen 42
Jambolo Methode, welche die 3 letzten Parameter Werte speichert Java Basics - Anfänger-Themen 20
LetsSebi Methode, die einen arry von objekten speichert in einer datei Java Basics - Anfänger-Themen 6
M Implementieren einer Datenstruktur, welche nur 5 Objekte speichert Java Basics - Anfänger-Themen 3
M Objekt einer Klasse speichert die Veränderung nicht Java Basics - Anfänger-Themen 1
D Erste Schritte Java speichert wert des Scanners nicht Java Basics - Anfänger-Themen 2
V Warum speichert meine String-Variable nummerische Werte? Java Basics - Anfänger-Themen 3
GreenTeaYT Variable speichert nicht die korrekte Zahl ein Java Basics - Anfänger-Themen 12
M Erste Schritte Wie speichert und gibt man Arrays aus? (JLabel) Java Basics - Anfänger-Themen 12
N Klassen Class nur einmal ausführen und sie speichert daten für alle anderen classes? Java Basics - Anfänger-Themen 3
H Wo speichert man am besten Daten? Appdata? Java Basics - Anfänger-Themen 14
A Jar speichert änderung nicht Java Basics - Anfänger-Themen 14
R Kalender speichert keine Zeit Java Basics - Anfänger-Themen 2
M OOP ArrayList speichert nicht richtig Java Basics - Anfänger-Themen 3
7 Array speichert Werte nicht? NullPointerException Java Basics - Anfänger-Themen 2
G wo speichert man am besten eine Datei? Java Basics - Anfänger-Themen 4
D Klasse speichert Daten nicht wie sie soll Java Basics - Anfänger-Themen 4
E DB4O speichert mein JLayeredPane nicht ab! Java Basics - Anfänger-Themen 13
NightmareVirus java speichert daten net Java Basics - Anfänger-Themen 3
M arraylist die hashmaps speichert? Java Basics - Anfänger-Themen 2
R Speichert eine ArayList Strings oder Integer Java Basics - Anfänger-Themen 4
A Am Buch lesen, nun brauch ich eure Hilfe um mir super() zu erklären Java Basics - Anfänger-Themen 4
N Will eure meinung Wissen Java Basics - Anfänger-Themen 15
G Ich brauche eure Hilfe! Java Basics - Anfänger-Themen 8
G Brauche eure Hilfe bei meinem Programm Java Basics - Anfänger-Themen 4
S Brauch mal eure Hilfe . Java Basics - Anfänger-Themen 7
D JTextArea Probleme !!! Brauche eure Hilfe Java Basics - Anfänger-Themen 2
B Wie schreibt ihr eure Programme? Klassenweise oder linear? Java Basics - Anfänger-Themen 10

Ähnliche Java Themen

Neue Themen


Oben