Автоматическое создание всей встроенной XML-документации для проекта C#.

У меня есть проект с более чем 100 классами C#, и я хочу создать документацию для каждой переменной, свойства и метода. В Visual Studio macOS IDE вы можете сделать это для 1 метода за раз с помощью /// , но сделать это для всех классов очень сложно.

Есть ли возможность автоматизировать это в Xamarin Studio/Visual Studio для Mac? Если нет, есть ли IDE, где я могу это сделать?

Мне не нужна программа, которая объединяет документацию (например, Doxygen), я хочу что-то, что добавляет встроенную документацию, я добавлю документацию сам (или отредактирую автоматически сгенерированную документацию).


xamarin visual-studio-mac c# xamarin-studio
person Robin Bruneel    schedule 23.02.2017    source источник
comment
Итак, вам нужно что-то, что будет генерировать для вас пустые сводные теги?   -  person MaLiN2223    schedule 23.02.2017
comment
GhostDoc может помочь: submain.com/products/ghostdoc.aspx Однако он может только генерировать комментарии, полученные из информации в коде. Это делает его довольно бесполезным, если вы не обновите его полезной информацией.   -  person Caspar Kleijne    schedule 23.02.2017
comment
@MaLiN2223 MaLiN2223 Visual Studio для Mac не создает пустые теги. Он дает сгенерированную сводку и сводку по каждому параметру вашего метода.   -  person Robin Bruneel    schedule 23.02.2017
comment
Пробовали ли вы искать похожие проблемы? Проверьте ответы, например. этот вопрос.   -  person Sinatr    schedule 23.02.2017
comment
Проблема с автоматическим созданием комментариев к документации заключается в том, что тогда трудно отследить, какие из них в настоящее время бесполезны (просто сгенерированы автоматически), а какие полезны (с прикрепленной реальной документацией). Ваш единственный шанс узнать это наверняка — не создавать их автоматически.   -  person Damien_The_Unbeliever    schedule 23.02.2017
comment
Я не совсем уверен, что понимаю вашу точку зрения. Вы в любом случае должны документировать все типы и элементы, поэтому ваши накладные расходы составляют /// для каждого документированного объекта. Сгенерированные комментарии к документации, как отмечает Дэмиен, совершенно бесполезны, поэтому вам все равно придется просматривать каждый комментарий к документации. Я думаю, что три нажатия клавиши — ничтожно мало по сравнению с усилиями по фактическому написанию документации. Но если вы сразу после создания пустой сводки для всего, то это, вероятно, полчаса усилий, чтобы сделать с Roslyn.   -  person Joey    schedule 23.02.2017
comment
Как создать список задач в xamarin?   -  person Manthan    schedule 28.03.2018

Ответы (2)


arrow_upward
1
arrow_downward

Это можно сделать с помощью GhostDoc или SandCastle. Sandcastle — это отдельное приложение, которое будет работать с исходным кодом в папке вашего проекта, а Ghostdoc — это плагин для Visual Studio.

К сожалению, ни один из них не работает на Mac.

person vrwim    schedule 23.02.2017

arrow_upward
0
arrow_downward

Я использую doxygen для документации C#, он работает и для Xamarin.

person Anas EL HAJJAJI    schedule 23.02.2017
comment
Из вопроса: мне не нужна программа, которая объединяет документацию (например, Doxygen),... - person Damien_The_Unbeliever; 23.02.2017
comment
хорошо, извините, я предлагаю это, потому что я использовал его, и я нашел его идеальным. - person Anas EL HAJJAJI; 23.02.2017
comment
Как создать список задач в xamarin? - person Manthan; 28.03.2018