Список форматирования и правил Resharper по умолчанию - PullRequest
9 голосов
/ 10 января 2012

Я пытаюсь найти список всех стандартных форматов и правил, которые применяет Resharper.

К сожалению, мне не повезло.

Мы используем этот инструмент, но хотим предоставить документ о стандартах для новых сотрудников, чтобы они могли просматривать стандарты до кодирования.

Ответы [ 2 ]

7 голосов
/ 10 января 2012

В меню ReSharper, затем Options, вы найдете текущие правила и соглашения, которые ReSharper использует для этого решения. Особое значение имеют:

Проверка кода-> Серьезность проверки: Показывает серьезность обнаруженных в коде ReSharper. Чем больше вещей являются предупреждениями или ошибками, тем ближе вам придется согласовывать код с соглашениями ReSharper, чтобы файл «зеленел» или даже компилировался. Иерархия:

  • Не показывать - говорит само за себя, игнорирует проверку
  • Подсказка - не отображается на боковой панели, отображается в виде пунктирной линии под соответствующим кодом. Хороший пример: использование «var», когда строка кода не указывает явно назначаемый тип.
  • Предложение - отображается на боковой панели в виде зеленой галочки, рассматриваемый код имеет зеленое подчеркивание. Хорошие примеры: использование «var», когда тип явно определен в присваивании, видимость члена.
  • Предупреждение - отображается на боковой панели в виде желтой галочки, код, подчеркнутый синим цветом, или текст заштрихован. Нарушения соглашения об именах, избыточные ключевые слова или квалификаторы, неиспользуемые элементы кода.
  • Ошибка - красная галочка на боковой панели, код, о котором идет речь, либо красный текст, либо подчеркнутый красный. По умолчанию ничего, что не вызвало бы ошибку компиляции, помечается как ошибка ReSharper, но вы можете предотвратить компиляцию, «преобразовав» проверки с более низким приоритетом в ошибки.

Languages-> Naming Style: В этом разделе показано, как ReSharper будет ожидать форматирования имен элементов кода различных типов. Параметр «Расширенные настройки» также содержит «список сокращений», который в основном представляет собой список исключений из обычных соглашений об использовании верблюжьей шкуры. По умолчанию все несоответствия форматов являются предупреждениями, и я не вижу способа в 5.1 (версию, которую я использую) изменить серьезность этого.

РЕДАКТИРОВАТЬ: Вот список проверок и их серьезности по умолчанию для RS 4.5, который является несколько версий назад, но все еще должен иметь «мясо» проверок ReSharper C #. http://unintelligible.org/blog/2010/05/24/resharper-45-inspection-severity-list/

Помимо этого, даже JetBrains просто отправляет вас в окно «Параметры», если вы хотите просмотреть список проверок для вашего текущего языка. Так что, если вы хотите что-то более современное, возможно, вам придется сделать это самостоятельно. Если вы это сделаете, обязательно опубликуйте это где-нибудь, чтобы другим не пришлось повторять вашу работу.

1 голос
/ 10 января 2012

ИМХО стандарт кодирования компании - это больше, чем просто форматирование. Обычно он включает соглашения об организации проекта, рекомендации по использованию библиотеки и т. Д. Перечисление всех возможных правил форматирования, о которых знает ReSharper, сделает его довольно длинным и скучным. Достаточно нескольких примеров для общих конструкций (которые вы можете скопировать из нижней части окна настройки форматирования). Предоставление им краткого обоснования не должно быть слишком сложным для ручного выполнения.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...