chore: add comment style rules to eslint config

Add ESLint rules to enforce comment style:
- Require space after // in single-line comments
- Prefer JSDoc style for multi-line comments
- Warn on TODO/FIXME/HACK comments
- Update documentation with comment style guide
This commit is contained in:
imfozilbek
2025-11-23 21:42:51 +05:00
parent f7a02db7df
commit 6fe90a708b
2 changed files with 32 additions and 0 deletions

View File

@@ -89,6 +89,13 @@ From `eslint.config.mjs` and detailed in `LINTING.md`:
- Max lines per function: 100
- Max nesting depth: 4
4. **Comments Style:**
- Single-line comments must have a space after `//` (e.g., `// Comment`)
- Multi-line comments should use JSDoc style (`/** */`)
- No section divider comments (e.g., `// Entities`, `// Value Objects`) in code
- Comments should explain "why", not "what" (code should be self-documenting)
- TODO/FIXME/HACK comments trigger warnings
## Git Commit Format
Follow Conventional Commits format. See `.gitmessage` for full rules.