2008-09-09 3 views
19

Я всегда делал замечательные комментарии кодов для классов и методов с синтаксисом C# xml. Я всегда ожидал, что вы сможете легко их экспортировать позже.Как экспортировать документацию кода в C#/VisualStudio 2008?

Сегодня я действительно должен это сделать, но у меня возникли проблемы с выяснением того, как. Есть что-то, что мне не хватает? Я хочу пойти Menu-> Build-> Код сборки, но нет возможности сделать это.

+0

_OP приложил это предложение: _ Эта ссылка имеет простой xslt для быстрого и грязного экспорта: http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx – Mogsdad

ответ

24

Фактически он находится в свойствах проекта. Вкладку «Создание», раздел «Вывод», файл документации XML и введите имя файла. Он будет построен на каждой конструкции проекта.

После этого вы можете создать реальную справку с помощью Sandcastle.

+0

Вы все еще можете написать XSL/XSLT для форматирования XML для более приятного результата. – Biri

4

Вы можете попробовать NDOC или SandCastle, если вы не против использования сторонних инструментов.

+0

Хотя эта ссылка может ответить на вопрос, лучше включить здесь основные части ответа и предоставить ссылку для справки. Ответные ссылки могут стать недействительными, если связанная страница изменится. - [Обзор] (/ review/low-quality-posts/18546091) – Nae

1

Sandcastle прекрасно подходит для создания документации и поддерживает несколько разных форматов для поколения. Насколько мне известно, интеграция Visual Studio для него отсутствует, но для нее есть SandcastleGUI.

1

Будьте осторожны, если вы используете LINQ to SQL, так как вы не сможете легко добавлять устойчивые комментарии к автоматически генерируемым объектам.

0

Оригинальный проект NDoc (упомянутый другими) мертв, но есть новый проект под названием NDoc3.

NDoc3 поддерживает .NET 2.0 - 3.5. В настоящее время он доступен как бета-версия и отлично подходит для меня. Я не уверен, что проект по-прежнему активен - последняя бета-версия была выпущена в апреле 2009 года.

1

Поздний комментарий, но стоит добавить, что даже если Sandcastle законсервирован, Sandcastle Help File Builder остается в активной разработке, и я нашел его очень мощный и простой, чтобы погрузиться в дело только с этой ситуацией - установите на богатый .chm и .html/.asp вывод через пару часов.

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

  • Нет связанных вопросов^_^