Links
Innerhalb Ihrer Dokumentation können Sie auf externe Adressen verlinken. Das Ziel des Links wird durch die Verwendung einer URI (Uniform Resource Identifier) angegeben. Die URI muss in normale Anführungszeichen gesetzt werden, damit die XML-Bibliothek die Zeichenkette korrekt verarbeiten kann. Links müssen Sie immer innerhalb einer Description, Summary oder eines Examples einsetzen. Sie können Links entweder in der gleichen Textzeile einfügen oder vor den Link einen Zeilenumbruch setzen. Dafür nutzen Sie die Markups „see“ und „seealso“.
See
Verwenden Sie das Markup <see>, um einen Link innerhalb einer Textzeile zu erstellen.
Beispiel
Normalform:
(*!<description> You can find more information on our homepage
<see uri="http://www.beckhoff.de/TE1030"> Beckhoff Homepage </see>
</description>*)
Abgekürzte Form:
//!@description You can find more information on our homepage @see uri=http://www.beckhoff.de/TE1030 Beckhoff Homepage
In der Dokumentation sieht das so aus:
Seealso
Verwenden Sie das Markup <seealso>, um vor einem Link einen Zeilenumbruch zu erzeugen und so den Link in einen neuen Textabschnitt zu setzen.
Beispiel
Normalform:
//!<description> You can find more information on our homepage <seealso uri="http://www.beckhoff.de/TE1030"> Beckhoff Homepage </seealso> </description>
Abgekürzte Form:
//! @description You can find more information on our homepage @seealso http://www.beckhoff.de/TE1030
In der Dokumentation sieht das so aus:
