2014-01-26 12 views
8

in Microsoft Visual C# 2010 Express, wann immer ich eine Funktion, und verwenden Sie die 3 Schrägstriche erzeugen die Hilfe Code zu erstellen, bekomme ich so etwas wie diese:Wie wird der Inhalt des Tags <returns> angezeigt?

/// <summary> 
/// Function to sum 2 numbers. 
/// </summary> 
/// <param name="foo">First number.</param> 
/// <param name="bar">Second number.</param> 
/// <returns>The sum of the numbers.</returns> 
public int foobar(int foo, int bar) 
{ 
    return foo + bar; 
} 

Ich weiß, dass, wann immer ich will, was eine Funktion wissen kann ich meine Maus darüber bewegen, und der Tooltip zeigt den Text zwischen den <summary> Tags.

Wenn ich die Klammern öffne, um die Parameter der aufgerufenen Funktion zu schreiben, sehe ich den Tooltip unter dem Cursor, der den zwischen den Tags <param name="foo"> geschriebenen Text anzeigt.

Also, meine Frage ist: Kann ich den Text zwischen den <returns> Tags geschrieben sehen, ohne zur Definition gehen und es in dem Code sehen, in dem es geschrieben ist? Und wenn ja, wie?

Antwort

4

Sie können es in View >> Object Browser ansehen.

Abgesehen davon sehen Sie es nirgendwo anders. Falls Sie die "Return" Informationen über einen Tooltip anzeigen möchten, ist es besser, sie innerhalb der <summary> selbst als Teil der Beschreibung zu setzen. Es gibt einige Möglichkeiten, die <summary> readbarer zu machen, wenn Sie mehr Text hineinlegen möchten, z. unter Verwendung von <para>:

///<summary> 
///<para>line1</para> 
///<para>line2 (e.g. what a method returns)</para> 
///</summary> 
Verwandte Themen