Как ссылаться на константы перечисления в документах c # xml - PullRequest
15 голосов
/ 30 апреля 2010

Я хочу задокументировать значение по умолчанию для поля типа enum:

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

Компилятор предупреждает, что не может разрешить ссылку. Префикс F: или M: отключает компилятор, но E: также делает, так что я не уверен, какой префикс правильный.

Ответы [ 2 ]

10 голосов
/ 30 апреля 2010

Префиксы F, M и E действительны и, вероятно, причина исчезновения предупреждения компилятора.

Однако вы должны использовать F, который относится к полям. Для получения дополнительной информации о том, как Visual Studio генерирует идентификаторы документации, см .:

Обработка файла XML (Руководство по программированию в C #)

0 голосов
/ 12 апреля 2013

Не думаю, что вам нужен префикс - возможно, вам нужно добавить «использование» в пространство имен, где определен тип Orientation.

...