Стандарты кодирования

Правила написания чистого, понятного и поддерживаемого кода. Код должен читаться как литература, а не как ребус.

Стандарта

Маркеров

∞

Чистого кода

📚 Стандарты

Три столпа качества кода

Каждый стандарт решает свою задачу: документирование, намерения, навигация

📝

🔴 Критично

XML-Doc

Документирование публичного API с маркерами. Summary, параметры, возвращаемое значение, примеры. Обязательно для всех экспортных функций.

✦ ➤ ⬅

Подробнее →

💡

🟠 Высоко

Intention Block

Однострочное описание намерения функции. Код говорит "что", ib говорит "зачем". Контекст для ревьюера, ИИ и будущего себя.

ib = "..."

Подробнее →

✏️

🟣 Средне

SyntaxMarks

GPS для кода. Визуальные маркеры для быстрой навигации: изменения, циклы, тяжёлые операции, возвраты.

//✏ //⟳ //⚡ //↩

Подробнее →

💎 Философия

Почему это важно

Стандарты — не бюрократия, а инвестиция в будущее проекта

Readability

Код читают чаще, чем пишут

80% времени разработчик читает код, 20% — пишет. Инвестируй в читаемость сейчас, экономь часы потом.

AI Ready

Код для ИИ

Claude и GPT понимают контекст лучше, когда есть ib и XML-doc. Стандарты делают код "AI-friendly".

Onboarding

Быстрый вход новичков

Новый разработчик разберётся в коде за часы, а не за недели. Стандарты — это инструкция к проекту.

Example

Полный пример стандартного кода

// Фильтрует массив, оставляя уникальные элементы. ✦ // // Параметры: // ➤ Массив - Массив: Исходный массив с дубликатами. // // Возвращает: // ⬅ Массив - Новый массив без дубликатов. Функция Уникальные(Знач Массив) Экспорт ib = "Исключаем дубликаты сохраняя порядок оригинала"; Результат = Новый Массив; //✏ Для Каждого Элемент Из Массив Цикл //⟳ Если Результат.Найти(Элемент) = Неопределено Тогда Результат.Добавить(Элемент); //✏ КонецЕсли; КонецЦикла; Возврат Результат; //↩ КонецФункции

⚡ Быстрый старт

С чего начать

Пошаговое внедрение стандартов в проект

Step 1

XML-Doc

Начни с документирования публичных функций. Добавь ✦ Summary, ➤ параметры и ⬅ возврат. Это основа.

Step 2

Intention Block

Добавь ib = "..." в начало каждой функции. Одна строка — одно намерение. Пиши "зачем", не "что".

Step 3

SyntaxMarks

Расставь маркеры в сложных функциях: //✏ на изменениях, //⟳ на циклах, //↩ на возвратах.