Документирование с использованием Sandcastle: ссылка на значение enum с использованием <see> - PullRequest
6 голосов
/ 01 мая 2010

Я использую Sandcastle 2.4.10520 и Sandcastle Help File Builder 1.8.0 для создания файла справки .chm.

В своей документации я использую <see> теги.

Если я попытаюсь сослаться на перечисление как <see cref="NumberStyles"/>, оно отлично работает.

Если я пытаюсь сослаться на значение перечисления, например <see cref="NumberStyles.AllowTrailingWhite"/>, я получаю ссылку в файле документации, но эта ссылка приводит меня к Страница MSDN не найдена

Я не получаю никаких предупреждений - моя документация xml верна.

Я заметил, что страницы MSDN, которые ссылаются на значение перечисления, также имеют ссылку Страница не найдена. Например: UInt64.Parse Method (String, NumberStyles, IFormatProvider) относится к NumberStyles.AllowHexSpecifier, и это приводит к другой Страница MSDN не найдена .

Должен ли я ссылаться на перечисление вместо значения перечисления?

Что я должен сделать, чтобы сослаться на enum? Это вообще возможно?

1 Ответ

2 голосов
/ 01 мая 2010

Тот факт, что это происходит в MSDN, не сулит ничего хорошего.Имеют ли значения перечисления документацию XML?

Если я правильно помню, в SHFB должны быть настройки, которые позволят вам принудительно генерировать документацию для элементов, у которых нет XML - или, возможно, это настройка, которая позволяетисключить участников, у которых нет документа XML.В любом случае, дайте настройкам хороший результат, чтобы убедиться, что вы не исключаете члены перечисления таким образом.

В противном случае он должен генерировать документацию для каждого члена, а значения перечисления являются членами типов, аналогичныхконстантное или статическое поле будет.

РЕДАКТИРОВАТЬ: Похоже, по крайней мере, на более новом сайте MSDN, отдельные значения перечисления не имеют своей собственной страницы.Например, взгляните на перечисление NumberStyles .В этом случае у вас может не быть лучшего варианта, чем просто ссылка на enum.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...