Code beschreiben?

[Dr_Jekyll]

Hallo ich habe eine Webanwendung als Präsentationsthema.

Ich hab aber wenig Code (also eigentlich fast garkeinen selber gemacht ausser bisschen js). Des hatten wir alles schon als Vorlage. Soll ich den

Code den ich nicht selbst geschrieben habe auch beschreiben. Oder mich nur auf des beschränken, was ich auch wirklich gemacht habe...

[flashpixx]

Du solltest Deinen Ausbildungsberuf dazu schreiben.

Generell sollte Quellcode beschrieben sein, wenn Du externe Libraries einsetzt, dann musst Du diese nicht dokumentieren, aber es ist schon hilfreich, den Aufruf aus Deinem Code an die Library zu dokumentieren.

Phil

[Dr_Jekyll]

Anwendungsentwicklerin

[flashpixx]

Ich hab aber wenig Code (also eigentlich fast garkeinen selber gemacht ausser bisschen js). Des hatten wir alles schon als Vorlage.

Dann stellt sich mir bei einem FIAE die Frage, was Du als Projektarbeit machst, denn im Moment halte ich das Erstellen einer Webpräsenz ohne Programmierung für sehr wenig. Wurde der Antrag genehmigt? Vielleicht beschreibst Du Deine Arbeit umfassender.

Die Aufgabe des FIAE ist ein Projekt durchzuführen, in dem neben den kaufmännischen Sachen auch programmiert wird.

Phil

[DaddyDiesel]

Muss man eigentlich den Quellcode als Anhang zur Dokumentation beilegen? Weil dies hab ich nämlich nicht vor, da noch kleine Änderungen vorgenommen werden. Ich habe ja einen Programmablaufplan erstellt, der sollte ja reichen.

[HappyHero]

Ich werde auch höchstens ein paar Auszüge, wie irgendein Beispielhaftes Model oder einen Controller beifügen...

Ich finde nicht, dass der komplette Quellcode etwas außerhalb des Unternehmens zu suchen hat.

[Abd Sabour]

Muss man eigentlich den Quellcode als Anhang zur Dokumentation beilegen?

Lol - na stell dir das mal vor - ich hatte gut über 100 Source Files - von denen jede locker eine Seite füllte *g* und zumindest bei uns ist der Anhang auf 10 Seiten begrenzt => unlogisch => geht net!

Cheers,

AbdSabour

[DaddyDiesel]

Ja das ist bei uns auch auf 10 bis max 15 Seiten Anhang begrenzt. Ich komm schon mit dem Funktionsplan auf fast über 10 Seiten. Ja wollte blos nochmal Nachfragen, da viele Leute Teile aus Ihrem Quellcode als Anhang hinzufügen. Von mir gibts aufjedenfall keinen Quellcode... Danke für eure Antwort!!!

[Mariam]

Die Seitenanzahl ist ja beschränkt, von daher ist es ja auch unmöglich den ganzen Quellcode der Doku beizufügen.

Ich habe von ca 40 files nur ca 5 Seiten Code kopiert und meiner Doku eine CD mit dem kompletten Quellcode beigefügt. Ich denke, dass man so auf der sicheren Seite ist.

Wir dürfem max. 50 Seiten haben (davon 30 Seiten Anhang).

Bearbeitet 19. Mai 2009 von Mariam