Как настроить «очистку кода» Resharper для изменения правил заголовка документации в C#

#c# #resharper #code-cleanup

#c# #resharper #очистка кода

Вопрос:

Я хотел бы использовать code clean up для автоматического создания заголовков документации следующим образом:

 /// <summary>
/// **Some summary.**
/// </summary>
/// <param name="myParam">**The param.**</param>
/// <typeparam name="TService">**The type.**</typeparam>
/// <returns>**Whatever.**</returns>
TService Do<TService>(int myParam)
  

Это означает, что сводка содержит несколько строк, но остальные поля используют одну строку. В настоящее время мои настройки resharper по умолчанию всегда используют несколько строк.

Каков набор правил, которые управляют этим поведением в Resharper «очистка кода»? Возможно ли это?

Комментарии:

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

2. Спасибо, Майк, я действительно делал это, когда ты меня опередил.

Ответ №1:

Очистка кода в Resharper этого не сделает, но вы можете использовать GhostDoc. Он даже может писать правильные комментарии для множества распространенных методов (конструкторов, обработчиков событий, свойств и т.д.).

Ответ №2:

Я не буду создавать комментарии к XML-документу, только переформатирую их.

Однако это обновит заголовок файла…