Как выполнить выгрузку информации по классу по определённому правилу?

Question

[mindgrow]

Добрый день!

Есть класс с определёнными полями, комментариями и методами.

Хочу выгрузить информацию в виде:

НазваниеКласса
----НазваниеПоля (Комментарий)
----НазваниеМетода (Комментарий)

Как это можно быстро и просто сделать?
Есть ли такое решение, которое позволит выгружать инву по клику из пункта в контекстном меню? Я знаю что можно написать отдельную прогу, но интересует более интерактивные решения

Answer 1

[VoidVolker]

1. Документируете код согласно принятым стандартам, типа такого:
   

   /// <summary>
   /// Class description
   /// </summary>
   public class SomeClass { }

   
   
2. В параметрах проекта на вкладке "Сборка" ставите галочку "XML-файл документации — далее файл документации можно скормить любому приложению/скрипту, понимающему xml.
   
3. Далее ставите приложение Doxygen
   
4. В doxygen создаете проект документации, указываете xml файл документации и все требуемые настройки и сохраняете проект в файл
   
5. Теперь документацию по всему коду в удобном формате (HTML, LaTeX, RTF, Man, XML, DocBook) можно получить просто выполнив команду:
   doxygen.exe doxyproject
   

Comments

[mindgrow]

Я сделал с помощью Sandcastle, это конечно круто, и я давно хотел выгружать в chm файлы документаций и спасибо вам.

Но может вы знаете как сделать плагин для VS, чтобы я кликнув по классу смог выгрузить упрощенное описание класса в том простом виде, в котором я выше написал? Такие файлики проще анализировать

[VoidVolker]

Написать скрипт на любом удобном вам инструменте. Да хоть на C# TT шаблоне для генерации кода.

[mindgrow]

VoidVolker, вот сейчас на Roslyn пишу, но это будет отдельная программа, а хочу чтобы в интерфейсе VS прям появился пункт контекстного меню при наведении на класс, и я там выбирал, "выгрузить описание"

[VoidVolker]

Средства -> Внешние инструменты -> Добавить