z-astral/PCC

### Principal OOP AI Engineering Skill
High-Density Object-Oriented Programming • Zero Inline Noise • Terse Scope-Proportional Naming • Flat Control Flow
🇬🇧 English •
🇮🇩 Bahasa Indonesia •
🇯🇵 日本語 •
🇨🇳 简体中文 •
🇮🇳 हिन्दी •
🇷🇺 Русский
# 🇬🇧 English Documentation
> [!NOTE]
> What is Pretty and Clean Codes (PCC) in simple terms?
> Think of PCC as a "Senior Engineer Brain Chip" (Instruction Manual) for your AI coding assistant (such as Cursor, Claude Code, Google Antigravity, OpenCode, Devin, Windsurf, or GitHub Copilot). Once installed, your AI stops writing messy, overly long beginner code and starts writing clean, compact, Object-Oriented code like a Principal Software Architect.
## 💡 Why PCC? (Explained for Everyone)
If you have ever asked an AI to write code, you probably noticed three annoying habits:
1. Narrator Comments Everywhere: The AI writes useless comments on almost every line (// initialize variable, // loop through users), making your file look like a beginner's textbook.
2. Essay-Length Variable Names: The AI creates 40-character variable names like temporaryCustomerAuthenticationTokenString instead of clean, industry-standard names like tok or cfg.
3. Spaghetti if/else Pyramids: The AI nests if inside else inside if up to 6 levels deep, scattering loose functions everywhere instead of organizing them into neat Object-Oriented Programming (OOP) classes.
> [!TIP]
> Save 35%–45% of Your AI Token Quota & Speed Up Generation!
> Because PCC eliminates useless inline comments, compresses verbose variable names, and flattens nested blocks, your AI generates nearly half as many output tokens for the exact same functionality. Responses finish almost 2x faster and cost significantly less on paid API tiers.
## 🏛️ The 4 Engineering Pillars
text
┌─────────────────────────────────────────────────────────────────────────┐
│ PRETTY AND CLEAN CODES (PCC) │
├──────────────────┬──────────────────┬──────────────────┬────────────────┤
│ PILLAR I │ PILLAR II │ PILLAR III │ PILLAR IV │
│ Strict OOP │ Zero Inline │ Terse Scope │ Vertical │
│ Encapsulation │ Comments │ Naming │ Compression │
├──────────────────┼──────────────────┼──────────────────┼────────────────┤
│ • Cohesive class │ • 0 // or # in │ • Micro: it, v, │ • Guard clause │
│ architecture │ method bodies │ k, i, acc, fn │ early return │
│ • readonly state │ • 100% signature │ • Local: ctx, │ • No else │
│ • private helper │ Docblocks on │ cfg, req, res, │ after return │
│ isolation │ classes/methods│ buf, tx, err │ • 3-15 LOC max │
└──────────────────┴──────────────────┴──────────────────┴────────────────┘
### 1. Strict Object-Oriented Encapsulation (OOP)
No loose, floating functions. All business logic, state, and helpers are encapsulated inside cohesive classes (AuthSvc, TokenGuard, OrderCalc, PacketBuf) with explicit visibility modifiers (private, protected, public, readonly).
### 2. Zero Inline Comments & 100% Signature Docblocks
Zero (0) comments are allowed inside a function's body. Instead, PCC forces the AI to write a comprehensive, professional Docblock (JSDoc, TSDoc, Javadoc, or Docstring) directly above the class and method signature—documenting what the function does, its @param inputs, and its @returns output.