Skip to content

Latest commit

 

History

History
82 lines (45 loc) · 1.96 KB

check_description.md

File metadata and controls

82 lines (45 loc) · 1.96 KB

Описание проверок

  1. Создайте файл описания проверки на английском c идентификатором в имени файла
    • Например: com.e1c.v8codestyle.bsl/markdown/my-check-id.md
  2. Создайте файл описания проверки на русском
    • Например: com.e1c.v8codestyle.bsl/markdown/ru/my-check-id.md
  3. Укажите
    • Краткое название проверки
    • Полное описание проблемной ситуации в коде или метаданных, того как работает проверка
    • Добавьте пример неправильного кода
    • Пояснение почему так делать не стоит
    • Добавьте пример правильного кода

Читайте подробнее советы по наименованию и описанию.

Шаблоны файлов

Английский com.e1c.v8codestyle.bsl/markdown/my-check-id.md

# Title of the ckeck

Description of the check

## Noncompliant Code Example


 ```bsl

Noncompliant = code example;

Compliant Solution

Compliant = code example;

See


Русский `com.e1c.v8codestyle.bsl/markdown/ru/my-check-id.md`


```txt

# Заголовок проверки

Описание проверки

## Неправильно

 ```bsl

Пример = не правильного кода;

Правильно

Пример = правильного кода;

См.