Note

Das Markup Note verwenden Sie, um eine Sicherheitswarnung zu definieren. Das gesamte Markup müssen Sie entweder in eine Description, Summary oder ein Example einbetten. Für das Markup Note gibt es keine abgekürzte Form.

Eine Sicherheitswarnung kann vom Typ Information, Warnung oder Gefahr sein. Den Typ der Sicherheitswarnung definieren Sie innerhalb des Markups als „Note Type“ mit einem Signalwort. Das Signalwort wird dann entsprechend der Gefahrenstufe farbig hinterlegt.

Mögliche Typen, die Sie definieren können:

<note type="hazard"> - Gefahr

<note type="warning"> - Warnung

<note type="information"> - Hinweis

Beispiel

Normalform:

//!<description> <note type="warning">Serious injuries are possible.</note> </description>