Vererben von Dokumentzeichenfolgen in der Python-Klassenvererbung [geschlossen]

Ich versuche, eine Klassenvererbung in Python durchzuführen. Ich möchte, dass jede Klasse und geerbte Klasse gute Dokumentationszeichenfolgen hat. Ich denke ...

Was sind die Kernelemente, die in die Support-Dokumentation aufgenommen werden sollen? [geschlossen]

Wie verwende ich Unicode-Zeichen in Pod und Perldoc?

Ich muss utf-8 Zeichen in meiner Perl-Dokumentation verwenden. Wenn ich benutze: perldoc MyMod.pmIch sehe seltsame Charaktere. Wenn ich benutze: pod2text MyMod.pmalles ist gut. Ich benutze Ubuntu / Debian. $ locale LANG=de_DE.UTF-8 ...

Java Swing: Eine Liste aller UIDefaults-Eigenschaften

Frage: Wo kann ich eine Liste aller in Swing vorhandenen UIDefaults-Eigenschaften erhalten? Ich kenne die Möglichkeit, einen kleinen Codeausschnitt zu schreiben, der sie nur extrahiert und anzeigt, aber ich möchte wissen, ob die Liste, die ich ...

Warum enthalten Python-Funktionsdokumente das Komma nach der Klammer für optionale Argumente?

Das Format der Funktionssignaturen in den Python-Dokumenten ist etwas verwirrend. Was bedeutet es, das Komma nach der offenen Klammer zu setzen und nicht vorher? Welche Bedeutung hat das Verschachteln der Klammern? Wie sie ...

Kann ich die variable Erweiterung in der Sphinx-Dokumentation unterdrücken?

In meinem Code habe ich X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']und später def ...

So dokumentieren Sie Python-Pakete mit Sphinx

Ich versuche, ein Paket in Python zu dokumentieren. Im Moment habe ich folgende Verzeichnisstruktur: . └── project ├── _build │ ├── doctrees │ └── html │ ├── _sources │ └── _static ├── conf.py ├── index.rst ├── __init__.py ├── make.bat ├── ...

Unit Test Dokumentation [geschlossen]

Ich würde gerne von denen erfahren, die Unit-Tests dokumentieren, wie sie diese dokumentieren. Ich verstehe, dass die meisten TDD-Follower behaupten, dass "der Code spricht" und daher die Testdokumentation nicht sehr wichtig ist, da der Code ...

Doxygen vs Javadoc [geschlossen]

Ich habe gerade in einem Artikel in CACM festgestellt, dass Doxygen auch mit Java (und mehreren anderen Sprachen) funktioniert. Aber Java hat bereits das Javadoc-Tool. Kann jemand erklären, was die Vor- und Nachteile beider Ansätze sind? ...

Wie erstellt man Javadoc aus Quellen in einer .jar-Datei?

Ich muss Javadoc bauen ausmyCode.jar Das enthält sowohl Quell- als auch Klassendateien. Kann ich es tun, ohne das Glas zu ...