首页
This commit is contained in:
@@ -71,6 +71,7 @@ If a component requires a large amount of static data (e.g., "dead" data for ren
|
||||
**Every method, property, interface, and complex logic block MUST be documented.**
|
||||
|
||||
- **Language Requirement**: All comments inside the code (JSDoc and internal) **MUST be written in Chinese**.
|
||||
- **Mandatory Positive Constraint**: Every new **interface**, **type**, **exported or module-level constant**, **function component**, and **business logic function** MUST have a JSDoc `/** */` comment in **Chinese**. The only exception is for local variables within a function that are immediately obvious and self-explanatory.
|
||||
- **Public API/Props/Interfaces**: Use JSDoc style `/** ... */` **mandatory** for every interface definition and **every single property** within that interface.
|
||||
- **Methods & Functions**: Every function (exported or internal) **must** have a `/** ... */` comment explaining its purpose, parameters, and return value.
|
||||
- **Internal Logic**: Use double-slash `//` for step-by-step explanations inside function bodies.
|
||||
|
||||
Reference in New Issue
Block a user