Создание XML-документации для частных членов
Есть ли способ создать XML-документацию для частных участников? По умолчанию он генерирует его только для общедоступных членов, что верно для опубликованного кода, но не для кода, используемого только внутри компании.
Ответы 3
Я советую писать xml-документацию вместе с кодом. Это не занимает много времени, и я также обнаружил, что этот подход помогает мне лучше организовать структуру кода.
(Эээ ... комментарии к документации, а не сам метод. Ага!)
Для того, кто не имеет представления о методе, глупый комментарий покажет, что в этом нет ничего особенного;). Но вы правы, иногда комментарии - это просто трата времени и байтов.
Попробуйте использовать GhostDoc.
Для Sandcastle ответ дан здесь: Sandcastle не создает документы частных методов (C#)
(Включите DocumentPrivates в Sandcastle.)
Справа: XML-документация, созданная инструментом, почти никогда не бывает полезной Или вы думаете, что метод Add (Product p) с комментарием XML-документации «Добавляет продукт» (и <param name = "p"> Продукт для добавления </param>) стоит своих байтов ...?