Wenn ich in Microsoft Visual C # 2010 Express eine Funktion erstelle und die 3 Schrägstriche verwende, um den Hilfecode zu erstellen, erhalte ich Folgendes:
%Vor% Ich weiß, wann immer ich wissen möchte, was eine Funktion macht, kann ich meine Maus darüber bewegen, und der Tooltip zeigt den Text an, der zwischen den <summary>
-Tags geschrieben wurde.
Auch wenn ich die Klammern öffne, um die Parameter der aufgerufenen Funktion zu schreiben, sehe ich den Tooltip unterhalb des Cursors, der den zwischen den <param name="foo">
-Tags geschriebenen Text anzeigt.
Meine Frage lautet also: Kann ich den Text sehen, der zwischen den <returns>
Tags geschrieben wurde, ohne zur Definition gehen zu müssen und ihn in dem Code zu sehen, in dem er geschrieben ist? Und wenn ja, wie?
Sie können es in View >> Object Browser
anzeigen.
Abgesehen davon sehen Sie es nirgendwo anders.
Falls Sie die "return" Informationen über einen Tooltip anzeigen möchten, ist es besser, sie als Teil der Beschreibung in <summary>
selbst einzufügen.
Es gibt einige Möglichkeiten, die <summary>
readbarer zu machen, wenn Sie mehr Text hineinlegen möchten, z. mit <para>
:
Tags und Links c# visual-studio-2010 visual-studio xml-documentation