Документирование с использованием Sandcastle: ссылка на значение перечисления с использованием <see>

Question

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

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

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

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

Я не получаю никаких предупреждений - мой XML-документы правильно.

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

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

Что мне делать для ссылки на перечисление? Возможно ли это?

Answer 1

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

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

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

EDIT: По крайней мере, на новом сайте MSDN индивидуальные значения перечисления не имеют собственной страницы. Например, посмотрите на перечисление NumberStyles. В этом случае у вас может не быть лучшего варианта, чем просто привязка к перечислению.