.NET // vs /// Соглашение о комментариях

Question

Я просто проверяю F #, поэтому извиняюсь, если это глупый вопрос, но в проекте VS2008 F # CTP 1.9.6.2 'Tutorial', оба // и /// используются для комментирования кода.

Есть ли функциональная разница между двумя косыми и тремя косыми комментариями, или это условно (как это показано в учебном коде) комментировать функцию с помощью /// и использовать // для всего остального?

Answer 1

Использование трех косых черт (///) - это соглашение C # для Комментарии к документации XML , также принятое F #.

Answer 2

/// для комментариев документации. VS будет использовать его при генерации информации о intellisense.

Answer 3

Это похоже на /* comment */ против /** documented comment */ в Java.

Последний работает так же, но также признается программным обеспечением документации как документация для разработчиков, а не просто как примечание.

Answer 4

/// или '' 'для C # и VB.Net - это гораздо больше, чем внутренние комментарии. Если в свойствах проекта можно включить XML-файл документации , можно использовать Sandcastle и HTML-справку для создания четырех различных типов документации (файлы и веб-сайты). См. https://github.com/EWSoftware/SHFB/wiki и документы Microsoft . Дополнительно, это может быть добавлено к вашему процессу CI.