Заголовок XML-документации StyleCop - использование 3 /// вместо 2 // - PullRequest
19 голосов
/ 17 марта 2010

Я использую заголовки документации XML в моих файлах c # для передачи правила StyleCop SA1633.

В настоящее время я должен использовать правило комментирования с двумя косыми чертами, чтобы StyleCop мог распознавать заголовок. например:

// <copyright file="abc.ascx.cs" company="MyCompany.com">
//     MyCompany.com. All rights reserved.
// </copyright>
// <author>Me</author>

Это прекрасно работает для StyleCop, однако я хотел бы использовать правило комментирования с 3 слэшами, чтобы Visual Studio могла понимать комментарии как XML и предоставлять функциональность XML (выделение, автоматическое отступление и т. Д.)

/// <copyright file="abc.ascx.cs" company="MyCompany.com">
///     MyCompany.com. All rights reserved.
/// </copyright>
/// <author>Me</author>

Проблема в том, что при использовании 3 косых черт StyleCop больше не видит заголовок и выдает предупреждение SA1633.

Есть ли способ настроить stylecop, чтобы понять, что заголовок содержится в XML с использованием 3 косых черт?

1 Ответ

12 голосов
/ 17 марта 2010

Вы можете создать собственное правило и отключить оригинал в пользу вашего нового: http://scottwhite.blogspot.com/2008/11/creating-custom-stylecop-rules-in-c.html

...