docs(code): add en code style conventions

This commit is contained in:
boykopovar 2026-09-25 14:56:13 +03:00
parent b163c938f3
commit 7133eebabf
3 changed files with 11 additions and 9 deletions

View File

@ -14,7 +14,7 @@ The [shader recompiler](core/shader/recompiler/Recompiler.cpp) successfully prod
The real game reaches the logo, main menu, and [gameplay](https://gist.github.com/user-attachments/assets/81d28e9b-c237-4545-b2ca-720071129816) with audio.
[Technical debt of the project](docs/TechnicalDebt.md)
[Technical debt of the project](docs/TechnicalDebt.md), [code style conventions](docs/CONVENTIONS.md)
## Build

View File

@ -1,9 +1,11 @@
# Соглашения по написанию кода
# Coding Conventions
### Именования C++
### C++ Naming Conventions
- Название интерфейса (класса с виртуальными методами без реализации) начинается с `I` (как в C#).
- Названия классов, публичных методов: PascalCase.
- Названия приватных методов и полей: \_camelCase.
- названия аргументов функций: camelCase.
- Названия параметров шаблона в стиле C#: `TKey`, `TValue`, `TIterator`.
- Interface names (classes containing only pure virtual methods with no implementation) start with `I`, as in C#.
- Class names and public method names use PascalCase.
- Private method and field names use camelCase.
- Function argument names use camelCase.
- Template parameter names follow the C# style: `TKey`, `TValue`, `TIterator`.
Comments in code can only be added to indicate areas of [technical debt](TechnicalDebt.md) (only by a human), the end of `#endif`, and the end of namespace.

View File

@ -2,7 +2,7 @@
### Build
- Building on Windows requires a specific version of mingw MinGW-w64 GCC 15.2.0 (`winlibs-gcc15`, `x86_64-ucrt-posix-seh`)
- Building on Windows requires a specific version of mingw - MinGW-w64 GCC 15.2.0 (`winlibs-gcc15`, `x86_64-ucrt-posix-seh`)
- Even compiled prx libraries on Windows require nearby (static linking of these dependencies causes conflicts):
- libgcc_s_seh-1.dll
- libstdc++-6.dll