PDA

Archiv verlassen und diese Seite im Standarddesign anzeigen : tutorial fuer pydoc



luh
11-06-2005, 19:38
hi leuts
ich suche ein tutorial, das mir sagt, wie ich pydoc benutze, damit ich das in meinem aktuellen py-prog verwenden kann. doxygen auf python zu verwenden waere irgendwie seltsam, wenn es pydoc gibt. aber ich muesste irgendwie wissen wie man das schreibt.
wenn ihr ne idee habt, - waer klasse
gruss
luh

Joghurt
12-06-2005, 00:17
# Foo.py
"Mache tolle Sachen"
class Foo:
"""Die Klasse Foo macht ganz tolle Sachen.
Sie ist aber so geheim, das hier nicht verraten werden kann, was"""
def Bar(self):
"Bart das Foo-Objekt"


pydoc Foo
Oder meintest du was anderes?

luh
12-06-2005, 09:14
bin nicht sicher. habe damit noch nicht gearbeitet. ist das alles an moeglichkeiten um sachen zu beschreiben? ich meine gibt es nicht sowas wie in javadoc @param, @return...?
gruss
luh

fs111
12-06-2005, 10:52
Für die erweiterten Doctags solltest Du epydoc (http://epydoc.sf.net) benutzen, das verwenden wir auf der Arbeit auch.

fs111

Kikone
29-01-2009, 10:29
Hallo :-)

Ich hab gelesen dass du epydoc benutzt. Ich habe auch mehrere Python Skripte geschrieben die ich nun dokumentieren lassen möchte. Meine Python Installation ist Version 2.1.3 und der EpyDoc hat die Version 3.0.1
Ich bin nach der Installationsalnleitung vorgegegangen. Jedoch weiss ich nicht wie man den epydoc benutzt geschweige denn die gui öffnet. Ich hab schon versucht sämtliche Dateien zu starten aber nicht passiert. Kannst du mir helfen?

Danke & Gruss,

Kikone