Читабельність коду для ШІ вимірює, чи є кодова база читабельною для мовної моделі: чи несе код машинно перевірювану інформацію про типи та чи вміщуються файли в робочий контекст моделі без утруднень. Ті самі властивості, що допомагають людині орієнтуватися в незнайомій кодовій базі, допомагають і моделі — але для моделей завеликі файли є жорстким обмеженням, а не просто незручністю.
- Категорія: Готовність до ШІ (15% у межах категорії)
- Вага в загальному індексі: 0% — частина незалежного бейджа «Готовність до ШІ»
- Ключ метрики:
ai_code_legibility nullдля репозиторіїв без виявлених файлів вихідного коду — проєкти, що містять лише документацію, не штрафуються
Як обчислюється значення
| Компонент | Вага | Критерії |
|---|---|---|
| Типізований код | 45 | статично типізована мова → 45 балів; динамічно типізована з конфігурацією перевірки типів → 27; жодного з двох → 0 |
| Керовані розміри файлів | 55 | (1 − завеликі / усього) × 55, де файл вихідного коду понад ~60 КБ (~1 500 рядків) вважається завеликим; вендорні та згенеровані шляхи виключаються |
Чому саме ці два сигнали
- Типи — це стисла документація. Типізована сигнатура повідомляє моделі, що функція приймає і повертає, без читання її тіла — а перевірка типів перетворює хибні уявлення моделі на негайні механічні помилки замість прихованих дефектів. Часткові бали для динамічно типізованих проєктів із перевіркою типів (mypy, pyright, tsconfig) відображають те, що поступова типізація дає значну частину користі.
- Розподіл розмірів файлів визначає, чи може модель утримати одиницю коду в контексті цілком. Кодову базу зі сфокусованих модулів можна читати частинами; файл на 5 000 рядків змушує обрізати вміст, а саме на обрізанні й концентруються помилки агентів.
Вендорний і згенерований код виключається, щоб закомічене дерево vendor/ або згенеровані прив'язки не спотворювали вимірювання.
Як читати результат
- Метрика читає структуру, а не стиль — іменування, коментарі та архітектура не оцінюються (див. правила чесності в Готовності до ШІ).
- Компонент розміру файлів пропорційний: один завеликий файл серед п'ятдесяти коштує мало; кодова база з монолітів читається відповідно.
Як покращити значення
- Запровадити перевірку типів; у динамічних мовах навіть поблажлива початкова конфігурація дає часткові бали та створює храповий механізм.
- Розділяти файли, що наближаються до ~1 500 рядків, за їхніми природними швами.
- Тримати згенерований і вендорний код у шляхах із загальноприйнятими назвами, щоб він виключався з вимірювання.
Дивіться також: цикл верифікації для ШІ · інтерфейси для ШІ