Mirrors_UI_SDK/GacUI
1
0
Fork 0
mirror of https://github.com/vczh-libraries/Release.git synced 2026-08-17 17:31:44 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Sync Copilot coding guidelines

Browse Source
This commit is contained in:
vczh
2026-05-15 15:23:07 -07:00
parent d0031a54a2
commit d8a4d3274c
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/Guidelines/Coding.md
+18 -1
View File
@@ -84,7 +84,24 @@ When `VlppParser2` is available to the current project, complex parsers always r
- Prefer the latest C++ features (up to C++ 20).
- Prefer template variadic arguments, over hard-coded-counting solutions.
## Advanced C++ Coding Rules for Reflectable Types
### for Thread Safe Programming
- Most of the code do not require thread safety, DO NOT over engineering.
- `SpinLock` is only for protecting a piece of code or data in a super flashy short time.
- When defining a `SpinLock` field, names it begins with `lock`, a `// covers a, b, c` comment is recommended to put above it, a empty line is recommended to put around it.
- When doing `read-process-write` but the `write` part doesn't depend on the result of `process`:
- The below rules only involve when `process` is heavy, if anything is simple, keep it simple.
- You can copy or move the heavy structure in `SPIN_LOCK`, and `process` after `SPIN_LOCK`.
- Especially for scenario when a container should be processed and cleared, `std::move` would be the best choice to copy and clean `Vlpp` containers. Using moved `Vlpp` containers is not undefined behavior.
- When using other locks, try your best to only use methods that available to all platforms.
- Write cross platform code when it is performance optimal for all platforms.
- If Windows specific methods could make Windows implementation much better, then you are allowed to implement them in different ways.
- Use `lock` (both `SpinLock` and `CriticalSection`), `mutex`, `semaphore`, `event`, `semaphore`, `rwlock`, `cv` as lock variable prefixes.
- Prefer lock free construction only when the code would be simple, DO NOT involve complex lock free trick unless explicitly required.
- `std::atomic<T>` should be considered and use it precisely. The code should be correct when running parallelly while I don't want unnecessary `std::atomic<T>`.
- `atomic_vint` is widely used in the library, use it for `vint`.
### for Reflectable Types
- Any interface or class `X` should inherit from `vl::reflection::Description<X>`.
- If such a class (not including interface) should be inheritable in Workflow script, use `AggregatableDescription` instead of `Description`.