docs: добавить вводные описания разделов документирования и типизации
This commit is contained in:
@@ -4,7 +4,7 @@ title: Документирование
|
||||
|
||||
# Документирование
|
||||
|
||||
Документирование должно помогать понять назначение сущности, а не дублировать её типы или очевидные детали.
|
||||
Этот раздел описывает правила документирования кода: когда и как писать комментарии к функциям, компонентам, типам и интерфейсам.
|
||||
|
||||
## Правила
|
||||
|
||||
|
||||
@@ -4,8 +4,7 @@ title: Типизация
|
||||
|
||||
# Типизация
|
||||
|
||||
Типизация обязательна для всех публичных интерфейсов, функций и компонентов.
|
||||
Цель — предсказуемость, безопасность и автодополнение.
|
||||
Этот раздел описывает правила типизации: как типизировать компоненты, функции и работу с `any`/`unknown`.
|
||||
|
||||
## Общие правила
|
||||
|
||||
|
||||
Reference in New Issue
Block a user