DIESER TAG IST NUR FÜR DOKUMENTENGENERATOREN. Fügen Sie auch Sprache und / oder SDE-Tag hinzu. NICHT VERWENDEN, um nach Links zu Dokumentation oder Tools zu fragen oder die Dokumentation des Anbieters zu kritisieren.
Ich habe vor kurzem angefangen, Python zu studieren , konnte aber keine mehrzeiligen Kommentare implementieren. Die meisten Sprachen haben Blockkommentarsymbole wie /* */ Ich habe dies in Python versucht, aber es wird ein Fehler ausgegeben, daher ist dies wahrscheinlich nicht der richtige Weg....
In Ziel C kann ich #pragma markAbschnitte meines Codes im Symbolnavigator markieren. Da dies ein C-Präprozessorbefehl ist, ist er in Swift nicht verfügbar. Gibt es dafür in Swift einen Ersatz oder muss ich hässliche Kommentare
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 2 Jahren . Ich habe in...
Diese Frage passt derzeit nicht zu unserem Q & A-Format. Wir erwarten, dass die Antworten durch Fakten, Referenzen oder Fachwissen gestützt werden, aber diese Frage wird wahrscheinlich zu Debatten, Argumenten, Umfragen oder erweiterten Diskussionen führen. Wenn Sie der Meinung...
Beim Schreiben von XML-Dokumentation können Sie verwenden <see cref="something">something</see>, was natürlich funktioniert. Aber wie referenzieren Sie eine Klasse oder eine Methode mit generischen Typen? public class FancyClass<T> { public string FancyMethod<K>(T value) {...
Dies sollte einfacher sein ... Ich möchte der XML-Dokumentation in meinem Code einen "codierten" Zeilenumbruch hinzufügen /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a...
Geschlossen. Diese Frage entspricht nicht den Richtlinien für Stapelüberlauf . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so dass es beim Thema für Stack - Überlauf. Geschlossen vor 2 Jahren . Verbessere diese Frage Eine der neuen...
Ich verstehe also vollkommen, wie man Resample verwendet , aber die Dokumentation macht keine gute Arbeit darin, die Optionen zu erklären. Die meisten Optionen in der resampleFunktion sind also ziemlich einfach, mit Ausnahme dieser beiden: Regel: Die Offset-Zeichenfolge oder das Objekt, die die...
Ich weiß, dass dies nicht das wichtigste Problem ist, aber ich habe gerade festgestellt, dass ich den Javadoc-Kommentarblock vor oder nach der Anmerkung einfügen kann. Was möchten wir als Codierungsstandard übernehmen? /** * This is a javadoc comment before the annotation */ @Component public...
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 2 Jahren . Verbessere diese...
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten .
Wie kann ich JSDoc über die Struktur eines zurückgegebenen Objekts informieren? Ich habe die @return {{field1: type, field2: type, ...}} descriptionSyntax gefunden und ausprobiert: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid...
Wie dokumentiere ich Methoden mit Parametern mithilfe der Python-Dokumentationszeichenfolgen? EDIT: PEP 257 gibt dieses Beispiel: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag ==...
Ich schreibe derzeit ein kleines Framework, das intern von anderen Entwicklern im Unternehmen verwendet wird. Ich möchte gute Intellisense-Informationen bereitstellen, bin mir jedoch nicht sicher, wie ausgelöste Ausnahmen dokumentiert werden sollen. Im folgenden Beispiel: public void...
Geschlossen. Diese Frage entspricht nicht den Richtlinien für Stapelüberlauf . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so dass es beim Thema für Stack - Überlauf. Geschlossen vor 12 Monaten ....
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie durch Bearbeiten dieses Beitrags mit Fakten und Zitaten beantwortet werden kann . Geschlossen vor 6 Jahren . Verbessere diese...
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten .
In JSDoc zeigt die beste Dokumentation, die ich finden kann, Folgendes, wenn Sie ein Array eines bestimmten Typs (z. B. ein Array von Zeichenfolgen) haben: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Wie würden Sie die...
Gibt es einen Standard zur Interpretation der Syntax von Funktionsschnittstellen in API-Dokumentationen und wenn ja, wie ist dieser definiert? Hier ist ein Beispiel zum Ändern der Farbe eines Elements im JavaScript-Skripthandbuch für Photoshop für die Funktion
Die Dokumentation zum Aktivieren der XmlDoc-Integration in Ihre Web-Api-Projekte behandelt anscheinend nur Situationen, in denen alle Ihre API-Typen Teil Ihres WebApi-Projekts sind. Insbesondere wird erläutert, wie Sie die XML-Dokumentation in App_Data/XmlDocument.xmleine Zeile in Ihrer...