Dokumentation, die sich auf Code selbst konzentriert, wie z. B. seine Funktion, korrekte Verwendung, erwartete Ausgabe, Beziehung zu anderem Code sowie Datenbank- und Tabellenverbindungen und Anwendungsbeispiele.
Ich habe kürzlich R # 6.1 (C # Version, nicht Full) mit StyleCop 4.7.34.0 (mit dem R # Plugin) installiert. Wenn Sie einem Projekt eine neue Klasse hinzufügen, werden die Dateikopfinformationen automatisch hinzugefügt. Wie deaktivierst du das?...
11.07.2012, 22:48
Gibt es eine korrekte Methode, um Werte / Objekte in Arrays zu dokumentieren, die sich in einer anderen Dimension befinden?
Normalerweise wird ein Array wie folgt behandelt:
%Vor%
Aber ich brauche so etwas:
%Vor%
Dies funktioniert off...
12.12.2013, 12:04
Ich entschuldige mich für die Einfachheit meiner Frage, aber ich habe versucht, Dokumentation mit Appledocs ( Ссылка ) zu erstellen.
Ich bin mir nicht sicher, wie genau es eingerichtet werden soll. So wie ich es mache:
Ich klon das Github...
04.03.2013, 16:01
Wir verwenden ReSharper 6.0 mit StyleCop für ReSharper.
Obwohl wir die StyleCop-Regel verwenden, dass Mitglieder Dokumentationsheader haben müssen, wollen wir nicht, dass die ReSharper-Codebereinigungsfunktion Dokumentationsheader für uns gen...
17.11.2011, 10:14
Ich dokumentiere C # -Code mithilfe von XML und Sandcastle Help File Builder , um HtmlHelp1 Hilfedateien zu generieren. Ich habe die Eigenschaft SyntaxFilters im Sandcastle-Projekt auf CSharp gesetzt, da ich nur die für C # relevante Co...
05.07.2012, 12:23
Ich bin mit PHP-Dockblocks ziemlich vertraut, da es in den letzten 15 Jahren mein Job war.
%Vor%
Was ich versuche zu verstehen, ist, ob es einen Standard wie Delphi und / oder FreePascal gibt.
Aus meiner Analyse über eine Menge Code habe...
15.04.2009, 08:41