2010-04-30 8 views
9

ich den Standardwert eines ENUM-typisierten Feld dokumentieren möchten vorgelegt:Wie Enum-Konstanten in C# xml docs

/// <summary> 
/// The default value is <see cref="Orientation.Horizontal" />. 
/// </summary> 
public Orientation BoxOrientation; 

Der Compiler warnt davor, dass es nicht die Referenz auflösen konnte. Prefixing F: oder M: stumm den Compiler, aber E: tut auch, so dass ich nicht sicher bin, welches Präfix korrekt ist.

Antwort

10

Die Präfixe F, M und E sind alle gültig und wahrscheinlich der Grund, dass die Compilerwarnung verschwindet.

Sie sollten jedoch die F verwenden, die sich auf Felder bezieht. Weitere Informationen darüber, wie Visual Studio erzeugt Dokumentation Identifikatoren siehe:

Processing the XML File (C# Programming Guide)

0

Ich glaube nicht, dass Sie das Präfix brauchen sollte - wahrscheinlich müssen Sie eine „Verwendung“ auf den Namespace hinzufügen, wo die Orientation Typ definiert .