Best Practice Wie speichert/Dokumentiert Ihr eure Programme?

[cpt.Tomato]

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]

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

 

[Robat]

Schau dir mal Version Control Systems wie Git an.

 

[krgewb]

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]

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]

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]

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

/**
...
*/

fügt alles hinzu und wirft den javadoc-Compiler an 🙂 auch sehr nett 🙂

Ansonsten habe ich das gleiche Chaos wie alle anderen auch 😀

 

[mihe7]

Also ich bin ein totaler Anfänger und weiß deswegen leider nicht wie man eigene Bibliotheken schreibt.

Ganz einfach, indem Du deine Klassen zu einem Jar-File zusammenpackst 🙂

 

[White_Fox]

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.