docs/nextjs-style-guide
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: добавить вводные описания разделов документирования и типизации

Browse Source
This commit is contained in:
Сергей Громов
2026-03-31 15:18:04 +03:00
parent 2bf34e6f79
commit 2d1f3b9df9
2 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ru/basics/documentation.md
View File

@@ -4,7 +4,7 @@ title: Документирование
# Документирование # Документирование
Документирование должно помогать понять назначение сущности, а не дублировать её типы или очевидные детали. Этот раздел описывает правила документирования кода: когда и как писать комментарии к функциям, компонентам, типам и интерфейсам.
## Правила ## Правила

3
docs/ru/basics/typing.md
View File

@@ -4,8 +4,7 @@ title: Типизация
# Типизация # Типизация
Типизация обязательна для всех публичных интерфейсов, функций и компонентов. Этот раздел описывает правила типизации: как типизировать компоненты, функции и работу с `any`/`unknown`.
Цель — предсказуемость, безопасность и автодополнение.
## Общие правила ## Общие правила