naming
Ce que cela signifie#
A name not in its case (archec vet): PascalCase for definitions, systems and types, snake_case for parts, ports, functions and variables, SCREAMING_CASE for messages, constants and literals; requirement ids upper-case.
En détail#
A name's case says what it is, as in Go:
| What | Case | Example |
|---|---|---|
| a definition, a system, a type, an interface | PascalCase |
BrakeEcu, Car, Speed |
| a part, a port, a function, a variable | snake_case |
brakes, can0, regulate, target_speed |
| a message, a constant, an enum literal | SCREAMING_CASE |
BRAKE_CMD, MAX_SPEED, AUTONOMOUS |
| a requirement, a test plan, a case | as its document writes it | REQ-BRK-001, TP-AEB, TC-AEB-01 |
An imported name keeps its Arche id with as, for example
component flash_memory "FLASH" as c-1793752253957. To rename, use the editor
(F2): every use follows.
Comment le corriger#
Le message dit ce qui ne va pas et où, et souvent ce qui était voulu (Did you mean …?). Modifiez le modèle pour que ce que décrit cette page ne soit plus vrai, puis vérifiez à nouveau : archec check main.arche.
Un indice : une suggestion ; le modèle se construit tel quel.
Une remarque de style : archec vet la signale, archec check non ; archec fmt --write corrige celles de mise en page.
archec check --beginner reformule les messages les plus courants en mots simples, avec les noms qui existent.
La correction automatique#
The name is changed to the naming convention, with every use (offered). The editor's rename also renames the uses in Python. archec fix --only naming renames the uses in the model.
Elle devine quoi écrire, ou supprime quelque chose : VS Code la propose (Quick Fix), et archec fix ne l’applique que si vous nommez son code — archec fix main.arche --only naming.
Dans le terminal#
archec explain naming affiche cette explication ; archec explain style liste les codes de son domaine.