Tag: code-documentation

Die Dokumentation, die sich auf den code selbst, wie seine Funktion, den richtigen Gebrauch, erwartete Ausgabe, Beziehung zu anderen code als auch Datenbank-und Tabellen-verbindungen und Anwendungsbeispiele.

PHPDoc: Typehint in verschachtelten arrays (mit z.B. 2 Dimensionen)

2 Antworten

Gibt es eine richtige Art und Weise zu dokumentieren, Werte/Objekte, die in arrays, die in einer anderen dimension? Normalerweise ein array behandelt werden wie diese: /** @var ClassName $Array */ $Array = array( $InstanceOfClassName,.. ) Aber ich

Erstellen Sie eine "Schnelle Hilfe" - Eintrag in Xcode

7 Antworten

Wie erstelle ich schnelle Hilfe Einträge in Xcode für meinen eigenen code? Ich will ihn so ein coding-Unterstützung, was bedeutet, wie der Eclipse-Funktionalität beim Programmieren in Java. In eclipse bekommen Sie einen Kommentar von Ihnen oben angegebenen

code-comments code-documentation doxygen objective-c xcode

opencv-python-Dokumentation

1 Antworten

Kürzlich, ich will das OpenCV Bibliothek in Pythonaber die Dokumentation von Python Bindung von OpenCV ist sehr unklar und ungenügend ist. Ich möchte Fragen, wo finden Sie einige detaillierte Dokumentation der Python Bindung von OpenCV. Zuvor verwendete

code-documentation documentation opencv python

Was sind Best Practices für die Dokumentation von C # -Code mit XML-Kommentaren?

8 Antworten

Werde ich durch einige neue code, den ich schrieb und das hinzufügen von NDoc sytle Kommentare zu meinen Klassen und Methoden. Ich bin in der Hoffnung zu generieren, die eine ziemlich gute MSDN-Stil-Dokument für die Referenz. Im

c#code-documentation ndoc

Codestyle; javadoc vor oder nach der Annotation einfügen?

4 Antworten

Ich weiß, dass es nicht die lebenswichtigen Fragen, aber ich habe gerade realisiert, dass ich in der javadoc-Kommentar-block vor oder nach der annotation. Was würden wir uns verabschieden wollen, wie ein standard zur Codierung? /** * This

annotations code-documentation coding-style java javadoc

JSDoc: Rückgabeobjektstruktur

2 Antworten

Wie kann ich sagen JSDoc über die Struktur eines Objekts, das zurückgegeben wird. Ich habe festgestellt, dass @return {{field1: type, field2: type, ...}} description syntax und versuchte es: /** * Returns a coordinate from a given mouse

code-documentation documentation-generation javascript jsdoc jsdoc3

Dokumentieren von Node.js-Projekten

6 Antworten

Ich bin derzeit mit JSDoc Toolkit zu dokumentieren meinem code, aber es nicht ganz genau - es nämlich scheinen, zu kämpfen mit der Beschreibung von namespaces richtig. Angenommen, Sie haben zwei einfache Klassen, die in jeder Ihrer

code-documentation documentation node.js

Wie dokumentiere ich einen String-Typ in jsdoc mit begrenzten möglichen Werten?

4 Antworten

Ich bin eine Funktion akzeptiert einen string-parameter. Dieser parameter kann nur ein paar definierte Werte möglich. Was ist der beste Weg, um Dokument gleich? Sollte shapeType definiert werden als enum-oder TypeDef-oder etwas anderes? Shape.prototype.create = function (shapeType)

code-documentation google-closure google-closure-compiler jsdoc