Некоторые особенности использования XML-комментариев в C#, которые могут повлиять на процесс документирования API:

• Автоматическая генерация документации. 4 Компилятор C# создаёт XML-файл, содержащий структурированные данные, представляющие комментарии и подписи API. 1 Другие средства могут обрабатывать эти данные и создавать документацию, доступную для чтения человеком, например, в виде веб-страниц или PDF-файлов. 1
• Проверка соответствия комментариев подписям API. 1 Компилятор C# проверяет, соответствуют ли комментарии подписям API для соответствующих тегов. 1
• Синхронизация кода и документации. 4 При изменении кода автоматически изменяются соответствующие комментарии и повторно создаются документы. 4
• Поддержка вывода подсказок. 3 Практически все инструменты, в том числе и Visual Studio, поддерживают вывод подсказок, которые подгружаются из документации. 3
• Использование различных XML-элементов. 3 Помимо общих комментариев (summary), для документирования API можно использовать, например, элементы для описания возвращаемого значения (returns), значения свойства (value), исключения (exception) и примечаний (remarks). 3