Gewusst wie: Erstellen von JScript-XML-Codekommentaren

Aktualisiert: November 2007

XML-Codekommentare sind JScript (JavaScript)-Kommentare, die Sie zu Skriptfunktionen hinzufügen, um eine Zusammenfassung sowie Informationen zu Parametern und dem Rückgabewert einer Funktion bereitzustellen. In Visual Studio werden diese Textbeschreibungen mit IntelliSense angezeigt, wenn Sie auf die Skriptfunktion verweisen.

Hinweis:
XML-Codekommentare sind nur in den Dateien, Assemblys und Diensten verfügbar, auf die verwiesen wurde.

So erstellen Sie XML-Codekommentare für eine JScript-Funktion

• Schließen Sie summary, param-Elemente und returns-Elemente ein, und stellen Sie jedem Element drei Schrägstriche (///) voran.

  Hinweis:
  Die Elemente müssen sich in einer einzigen Zeile befinden.

  Im folgenden Beispiel wird eine JScript-Funktion gezeigt, die jedes der drei in XML-Codekommentaren unterstützten Elemente enthält.

  <script type="text/javascript">
    function areaFunction(radiusParam)
    {
        /// <summary>Determines the area of a circle based on a radius parameter.</summary>
        /// <param name="radius" type="Number">The radius of the circle.</param>
        /// <returns type="Number">The area.</returns>
        var areaVal;
        areaVal = Math.PI * radiusParam * radiusParam;
        return areaVal;
    }
  </script>
  

So zeigen Sie XML-Codekommentare mit IntelliSense an

• Geben Sie den Namen und die öffnende Klammer einer Funktion ein, die mit XML-Codekommentaren markiert ist, wie im folgenden Beispiel gezeigt:

  var areaVal = areaFunction(
  

  Wenn Sie die öffnende Klammer der Funktion eingeben, die die XML-Codekommentare enthält, verwendet der Editor IntelliSense, um die in XML-Codekommentaren definierten Informationen anzuzeigen.

Siehe auch

Aufgaben

Exemplarische Vorgehensweise: JScript-IntelliSense

Konzepte

Übersicht über IntelliSense für JScript