Zum Inhalt springen

Projektdokumentation FIAE


Empfohlene Beiträge

Hallo,

die Kammer und der PA sind zur Verschwiegendheit verpflichtet. Und veröffentlich ist jetzt ein hartes Wort. Die Doku steht später ja nicht im Internet, es sei denn Du stellt diese online, und somit sehen nur eine Hand voll Leute den Quellcode. Wenn die überhaupt reinschauen. Und anhand des Quellcodes kann man ganz gut erkennen ob Du das wirklich in der von dir angegebenen Realisierungsphase gemacht hast oder ob die Anzahl total den Rahmen sprengt und Du das niemals innerhalb von z. B. 12 Stunden geschrieben hast.

Frank

Link zu diesem Kommentar
Auf anderen Seiten teilen

Danke für die Antwort.

Dachte mir schon das der Code so natürlich nicht der Öffentlichkeit zugänglich gemacht wird, aber ist es ein Muss? Die Software ist in dem Sinne nur ein Prototyp und beinhaltet kaum vollständige Funktionen. Mein Projekt ist quasi nur ein Teil eines großen Projekts an dem zur Zeit 6 Leute sitzen und bis zur Fertigstellung noch gut zwei oder drei Monat verstreichen werden. Ich habe rund 35 Stunden Programmiert und der Source enthält keine Kommentare oder sonstiges, da wir dafür eigens eine Dokumentationsabteilung haben.

Falls ich also den Code mit abgebe, muss ich dazu noch Kommentare einfügen oder ähnliches?

Gruß

Link zu diesem Kommentar
Auf anderen Seiten teilen

Danke für die Antwort.

Dachte mir schon das der Code so natürlich nicht der Öffentlichkeit zugänglich gemacht wird, aber ist es ein Muss? Die Software ist in dem Sinne nur ein Prototyp und beinhaltet kaum vollständige Funktionen. Mein Projekt ist quasi nur ein Teil eines großen Projekts an dem zur Zeit 6 Leute sitzen und bis zur Fertigstellung noch gut zwei oder drei Monat verstreichen werden. Ich habe rund 35 Stunden Programmiert und der Source enthält keine Kommentare oder sonstiges, da wir dafür eigens eine Dokumentationsabteilung haben.

Falls ich also den Code mit abgebe, muss ich dazu noch Kommentare einfügen oder ähnliches?

Gruß

Insofern du code abgibst, sollte dieser für den/die Prüfer auch verständlich sein. Ich würde aufjedenfall Kommentare vor den Methoden einfügen, die deren Verhalten kurz zusammenfassen.

Wenn du Sourcecode aus verschiedenen Klassen anfügst, würde ich auch die Klassen kurz beschreiben.

Link zu diesem Kommentar
Auf anderen Seiten teilen

Wie schon gesagt, Code ist keine Pflicht.

Handle mit deiner Firma 3-4 Methoden aus, die du raus geben darfst und beschreibe diese beispielhaft.

Ich kenne mittlerweile einige Leute die sowieso garkeinen Quellcode in die Doku rein nehmen. In meiner ist auch keine einzige Zeile Code dabei, es geht ja mehr um das Projekt an sich und nicht um eine detailgenaue Beschreibung der Umsetzung.

Link zu diesem Kommentar
Auf anderen Seiten teilen

Gast KanchoKing

also mir hat man gesagt,

der quellcode soll aus gründen der

nachvollziehbarkeit uuuuunbedingt dabei

sein, aber das hält wahrscheinlich jede ihk anders ...

ich hab ihn dazu getan, auch wenn es gut 50 seiten mehr waren

(mit IntelliSense schreibt sich's einfach zu schnell weg ... ok, und ich hab viele leerzeilen :D )

egal, wenn se fragen haben - jeder zeit ^^

tippt einfach mit dem finger drauf ;D

~

Link zu diesem Kommentar
Auf anderen Seiten teilen

Dein Kommentar

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung wiederherstellen

  Nur 75 Emojis sind erlaubt.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...