1c/v8-code-style
1
0
Fork 0
mirror of https://github.com/1C-Company/v8-code-style.git synced 2024-12-14 14:10:09 +02:00
Code Issues Releases Activity
81575f3fbc
v8-code-style/docs/contributing/check_description.md
Dmitriy Marmyshev c924fd73eb #43 Исправление списков
2021-09-24 14:07:14 +03:00

2.0 KiB
Raw Blame History

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

  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

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

Правильно


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

См.