Документирование Замка из песка использования: Обращение к использованию перечисления значений <видит>
Я использую Замок из песка 2.4.10520 и Разработчика Справочного файла Замка из песка 1.8.0 для генерации .chm справочного файла.
В моей документации я использую
Если я пытаюсь отослать перечисление как
Если я пытаюсь отослать перечисление значений как
Я не получаю предупреждений - моя xml документация корректна.
Я заметил, что страницы MSDN, которые относятся к перечислению значений также, имеют Страницу, не найденную ссылкой. Например: UInt64. Метод синтаксического анализа (Строка, NumberStyles, IFormatProvider) относится к NumberStyles.AllowHexSpecifier и это приводит к другой Странице MSDN, не найденной.
Я должен обратиться к перечислению вместо перечисления значений?
Что я должен сделать для обращения перечисления? Это даже возможно?
1 ответ
Тот факт, что это происходит в MSDN, не сулит ничего хорошего. Есть ли у значений перечисления XML-документация?
Если я правильно помню, в SHFB должны быть настройки, которые позволят вам принудительно генерировать документацию для членов, у которых нет XML - или, может быть, это параметр, который позволяет вам исключать элементы, которые нет XML-документа. Тем не менее, проверьте настройки еще раз, чтобы убедиться, что таким образом вы не исключаете членов перечисления.
В противном случае он должен сгенерировать документацию для каждого члена, а значения перечисления являются членами тех же типов, что и константное или статическое поле.
РЕДАКТИРОВАТЬ: Похоже, что, по крайней мере, на новом сайте MSDN отдельные значения перечисления не имеют отдельной страницы. Например, взгляните на перечисление NumberStyles . В этом случае у вас может не быть лучшего варианта, чем просто ссылка на перечисление.