Python 3 Grundkurs

Dokumentation erstellen

Testen Sie unsere 1985 Kurse

10 Tage kostenlos!

Jetzt testen Alle Abonnements anzeigen
Python verfügt über einen einfachen Mechanismus, um Dokumentationen innerhalb eines Programms auf einfache Art und Weise zu erstellen.

Transkript

In diesem Video geht es um die Dokumentation von Software. Und zwar werde ich mal wieder unser Programm öffnen, File Recent Files - dieses hier - Und - ja, wir hatten hier sogar eine kleine Dokumentation reingeschrieben, Jetzt könnte man ja auch auf die Idee kommen, dass man ein Word-Dokument anlegt, und dort eine ausführliche Dokumentation zu jeder Klasse reinschreibt. Das ist aber problematisch, da manchmal die Dokumentation mit der Software auseinander läuft, und jedes mal, wenn man hier etwas ändert, muss man dann immer daran denken, dass man die Dokumentation noch mit abändert, und da das ein Dokument ist, das eventuell ganz woanders liegt, kann es passieren, dass das eben auseinander läuft. Python hat hierfür eine besondere Lösung, und zwar bietet Python hier eine Technik an, die sich Docstring nennt. Docstring ist ziemlich simpel gelöst, also Docstring funktioniert so, ich verwende jetzt mal diesen String hierfür, um Ihnen das mal zu zeigen, und zwar werde ich mit Docstrings die Klassen und die Methoden beispielsweise dokumentieren. Und zwar setze ich - die Beschreibung einer Klasse dann unter die Klasse, ich kann jetzt hier zum Beispiel schreiben: '''repräsentiert einen BMI Benutzer''', '''repräsentiert einen BMI Benutzer''', und genauso werde ich diese Klasse hier beschreiben: '''repräsentiert einen BMI Rechner''' Gut, das ist jetzt nicht sehr ausführlich, das wird man wahrscheinlich in einem professionellen Programm ganz anders machen, aber es soll ja nur zeigen, wie das grundsätzlich gemacht wird. Genauso kann ich die Methoden jetzt beschreiben, ich werde hier jetzt einmal diesen Konstruktor beschreiben, '''der Konstruktor des Benutzers''', und - ja, wie gesagt, hier müsste dann eigentlich noch viel mehr stehen, aber ich lasse es einfach mal so. '''der Konstruktor des BMI Rechners'''. So, das Ganze wird Docstring genannt, und Docstring ist eine spezielle Technologie, die folgendes anbietet, und zwar - wenn ich jetzt hingehen würde - ich kann das hier mal ausführen - So, gebe ich noch eine Körpergröße ein und so weiter, und dann irgendwelche - Gewichte, und jetzt will ich zum Beispiel wissen, ja - wie benutze ich denn eigentlich die Klasse Benutzer? Dann kann ich jetzt hier wieder help eingeben, so wie ich es Ihnen ganz am Anfang mal gezeigt habe, und wenn ich jetzt die Klasse Benutzer reinschreibe, in die Klammern, dann sehen Sie, dass das, was wir vorhin hier reingeschrieben hatten - unter die Klasse, das steht jetzt hier, genauso steht der Text hier, unter dem Teil, und so weiter, genauso könnte ich jetzt auch help und dann Bmirechner schreiben, und würde auch hier wieder die gleiche Hilfe angezeigt kriegen.

Python 3 Grundkurs

Lernen Sie die Entwicklungsumgebung sowie die grundlegenden Konzepte von Python kennen und schreiben Sie schon bald eigene Anwendungen.

4 Std. 33 min (49 Videos)
Ein tolles Python Tutorial für Anfänger
Dimitri S.

Im Großen und Ganzen ein wirklich gutes Howto, alles verständlich erklärt, die Geschwindigkeit ist OK, man kommt bei den Beispielen gut mit. Auf jeden Fall für Anfänger gut geeignet, man sollte sich jedoch schon mit Programmieren etwas beschäftigt haben. Hatte lange Zeit auf so ein Video Tutorial gewartet, analog zum Video, wäre noch ein Buch zum Nachlesen, aus meiner Sicht wünschenswert. Was ich bis jetzt vermisst habe, das Importieren der Module und wie man auf das Inhaltsverzeichnis (man Pages) dessen zugreifen kann, zum Nachlesen, was ein Modul für Funktionen bietet. Außer ich habe das Thema überhört, dann bitte ich um Entschuldigung. Ein Pluspunkt für gewählte Beispiele, endlich ein Tutorial, was fast ohne "Hello World" auskommt :-). Nichts gegen "Hello World", aber ein Beilspiel sollte schon Sinn machen, ansonsten versteht man den Zusammenhang nicht mehr, so meiner Erfahrung nach.

 
Software:
Exklusiv für Abo-Kunden
Erscheinungsdatum:26.03.2015

Dieser Online-Kurs ist als Download und als Streaming-Video verfügbar. Die gute Nachricht: Sie müssen sich nicht entscheiden - sobald Sie das Training erwerben, erhalten Sie Zugang zu beiden Optionen!

Der Download ermöglicht Ihnen die Offline-Nutzung des Trainings und bietet die Vorteile einer benutzerfreundlichen Abspielumgebung. Wenn Sie an verschiedenen Computern arbeiten, oder nicht den ganzen Kurs auf einmal herunterladen möchten, loggen Sie sich auf dieser Seite ein, um alle Videos des Trainings als Streaming-Video anzusehen.

Wir hoffen, dass Sie viel Freude und Erfolg mit diesem Video-Training haben werden. Falls Sie irgendwelche Fragen haben, zögern Sie nicht uns zu kontaktieren!