2013-11-20 4 views
3

Я использую последнюю версию Sandcastle для создания документации. У меня есть несколько общедоступных классов Instance с общедоступными и частными методами и полями. Публичные методы генерируются в окончательном выпуске документации Sandcastle, но не создаются другие члены. В разделе «Видимость» все проверено, поэтому я ожидаю, что в документации все должно быть создано.Sandcastle не генерирует частные методы docs (C#)

У кого-нибудь есть идеи?

+2

Почему вы хотите создавать документы API для частных методов? Они являются деталями реализации и поэтому не должны отображаться в какой-либо форме документации за пределами самого кода. –

+0

Потому что это для внутренних документов, где люди хотят знать, что происходит в кишках. – user1013388

+1

Затем они должны прочитать код. Ожидая, чтобы они смотрели на комментарии от кода, чтобы понять, что делает код, это безумие. –

ответ

2

Как из официального FAQ от Eric Вудрафф (разработчик Sandcastle Help File Builder)

Классы должны быть объявлены общественности в вашем коде, то Вам необходимо включить в DocumentPrivates и/или DocumentInternals проекта собственности так, чтобы Sandcastle документирует внутренние/частные члены, или вам необходимо, чтобы включал хотя бы одну сборку и по меньшей мере одно пространство имен для документирования.

+0

Да, это то, что у меня есть, публичные классы, и я включил show privates :) – user1013388

Смежные вопросы