Оновлене розширення Visual Studio IntelliCode, що підтримує стандарти оформлення коду для C#

Розширення Visual Studio IntelliCode допомагає писати код швидше, уникати помилок і пропонує розробникам підказки, передбачаючи цілі. Вийшло оновлення, значно спрямоване у бік покращення взаємодії з C#.

Розширення Visual Studio IntelliCode підтримує стандарти оформлення коду для C#. Воно допоможе вам і вашим колегам отримати більш читаний та узгоджений код. Якщо ви не знайомі з розширенням Intellicode, то в нього вже вбудована технологія IntelliSense за допомогою ІІ. Якщо розширення встановлено, то, можливо, воно вже оновилося автоматично.

Введення стандартів оформлення коду та форматування в базу

Якщо код узгоджений, то його зручніше обслуговувати та читати. Нещодавнє дослідження Microsoft Research у цій галузі показало, що 18 Відсоток коментарів з проханнями щодо допомоги з проблемами коду були пов'язані з помилками стандартів оформлення.

Оновлене розширення IntelliCode дозволяє на вимогу генерувати файл .editorconfig, що ідеально відповідає стандартам оформлення, що використовуються у вашому коді. Більше не треба вирішувати всім колективом, які стандарти слідувати!

Створивши цей файл один раз, ви зможете за допомогою його підтримувати однаковість бази вихідного коду для всіх членів групи. Також можна швидко і просто усувати проблеми з форматуванням, використовуючи меню швидких дій Quick Ctrl (Ctrl+ або Alt+Enter) або нову функцію Format Document (Ctrl+K, D), що настроюється, у Visual Studio 2017 версії 15.8 Preview 3 і вище.

Як використовувати .editorconfig

IntelliCode створює файл .editorconfig, скануючи файли коду нижче обраної вами точки, щоб створити якнайповніше відповідний набір стандартів. Коли його буде створено, ви побачите, що у списку помилок з'являться повідомлення про порушення стандартів стилю коду

Порушення стандартного стилю мають важливість рівня «Message». Це показує суфікс "suggestion" у кожному рядку правила у файлі .editorconfig. Ви можете налаштувати файл, якщо потрібен інший рівень виконання, наприклад, Warning або Error. Зверніть увагу, що порушення формату не відображаються у списку помилок, але їх можна легко усунути (див. наш посібник нижче).

Ви можете почати генерацію EditorConfig через браузер рішень. Просто натисніть правою кнопкою миші на папку з рішенням, проектом або підпапкою, до якої ви хочете застосувати стандарт, натисніть add («додати»), а потім EditorConfig file (IntelliCode) (Файл EditorConfig (IntelliCode)). В разі з проектом ви можете натиснути add («додати»), потім new item («новий елемент») і EditorConfig file (IntelliCode) (Файл EditorConfig (IntelliCode)).

Зверніть увагу, що файли EditorConfig застосовуються примусово в ієрархічному порядку до всіх файлів під ними. Наприклад, якщо вам потрібно застосувати набір стандартів до всього рішення, помістіть .editorconfig у каталог рішення. Якщо у вас є підпапки або проекти з різними стандартами, створіть новий файл EditorConfig для цих підпапок/проектів, щоб перезаписати стандарти вищого рівня.

Як виправити код, щоб він відповідав новим стандартам

Існує кілька способів очищення коду для відповідності новим стандартам залежно від ваших цілей.

Використання меню швидких дій Lightbulb (Ctrl+ або Alt+Enter)

Якщо існує проблема стилю, то з'явиться лампочка (а також список помилок), щоб ви могли автоматично виправити будь-які невідповідності. У меню Lightbulb можна вибрати область виправлення: екземпляр, документ, проект або рішення.
Використання функції Format Document (Ctrl+K,D)

Якщо виникають проблеми з форматом або стилем і ви використовуєте Visual Studio 2017 15.8 Preview 3 і вище, зверніться до розширеної функції Format Document, щоб додатково очистити код поточного документа. Вона допоможе виправити код у цьому документі, і він відповідатиме щойно створеним стандартам, а ви зможете очищати файли відразу в міру роботи з ними, забезпечуючи узгодженість.

Зверніть увагу, що додаткова можливість форматування документа стосується лише певного набору проблем, які можна змінити в меню Tools > Options > Text Editor > C# > Code Style > Formatting > General > Format Document Settings (Experiment) (Інструменти > Параметри > Текстовий редактор > C# > Стиль коду > Форматування > Загальні > Налаштування формату документа (експериментальна)):

І ще відзначте для себе, що стандартні налаштування не виправляють деякі стандарти стилю. Ви можете додати їх за допомогою настройок інструментів (наприклад, налаштування «Застосувати приховані/показувані типи» запустить правила стилю, пов'язані з використанням змінних у коді).

Що потрібно знати під час роботи з EditorConfig

Є кілька відомих проблем, які слід враховувати під час роботи з EditorConfig:

Необхідно закривати та знову відкривати файли, щоб відобразилися застосовані зміни стандартів у версії 15.8 Preview 2 і раніше.

У версіях Visual Studio 2017, 15.8 Preview 3, що вийшли раніше, слід закривати і повторно відкривати всі відкриті документи, щоб відобразилися зміни, що відбулися після створення стандартів у файлі EditorConfig. Це виправлено у версії 15.8 Preview 3.
При створенні файлу за допомогою діалогового вікна File-New Item (Файл-Новий елемент) до імені файлу додається «1».

Якщо ви використовуєте для створення файлу EditorConfig шлях до діалогового вікна File-New Item у версіях Visual Studio, що вийшли до 15.8 Preview 3, повинні вручну видалити зайвий префікс «1» в імені файлу EditorConfig. Це виправлено у версії 15.8 Preview 4.

Дякуємо вам за інтерес до IntelliCode. Ми будемо раді отримувати ваші відгуки та вдосконалювати IntelliCode у міру розвитку проекту. Використовуйте сторінку пропозицій, щоб висловити свою думку. Якщо ви виявите будь-які проблеми з розширенням, використовуйте вбудовану у Visual Studio функцію Report a Problem (Повідомити про проблему), напишіть у звіті, що йдеться про IntelliCode. Це допоможе нам зібрати необхідну інформацію для вирішення проблеми.

Зробіть свій внесок

У міру того, як ми розширюємо можливості, щоб охопити більше варіантів використання та мов програмування, ми надаватимемо обмежений попередній доступ до IntelliCode.

Зареєструйтесь для отримання доступу до обмеженої пробної версії, щоб стати учасником тесту та дізнатися про зміни першими.