Files
2nd/10_Wiki/Topics/AI_and_ML/Clean-Code-Principles.md
T

4.0 KiB

id, title, category, status, canonical_id, aliases, duplicate_of, source_trust_level, confidence_score, tags, raw_sources, last_reinforced, github_commit, inferred_by, tech_stack
id title category status canonical_id aliases duplicate_of source_trust_level confidence_score tags raw_sources last_reinforced github_commit inferred_by tech_stack
wiki-2026-0508-clean-code-principles Clean Code Principles 10_Wiki/Topics needs_review self
CS-CLEAN-CODE-001
none A 1.0
software-engineering
clean-code
srp
dry
kiss
refactoring
maintainability
2026-04-26 pending Claude Opus 4.7 (auto-normalize 2026-05-08)
language framework
unspecified unspecified

Clean Code Principles (클린 코드 원칙)

📌 한 줄 통찰 (The Karpathy Summary)

"코드는 컴퓨터가 읽기 위함이 아니라, 미래의 나를 포함한 '다른 인간'이 단번에 의도를 파악할 수 있도록 설계된 고도의 의사소통 수단이다" — 유지보수 효율을 극대화하고 소프트웨어의 부패를 막기 위한 코드 작성의 도덕적/기술적 기준.

📖 구조화된 지식 (Synthesized Content)

  • 추출된 패턴: "Human-Centric Engineering and Responsibility Separation" — 기계적인 동작 완성을 넘어, 이름 짓기(Naming), 함수 설계, 클래스 구조에서 의미적 명확성과 단일 책임(Single Responsibility)을 관철시키는 패턴.
  • 핵심 원칙:
    • Meaningful Names: 변수와 함수명은 존재 이유와 기능을 스스로 설명해야 함.
    • Single Responsibility (SRP): 하나의 함수/클래스는 오직 하나의 일만 수행하고 하나의 변경 이유만 가져야 함.
    • DRY (Don't Repeat Yourself): 중복은 시스템의 복잡도를 높이고 버그의 온상이 됨. 추상화를 통해 제거.
    • KISS (Keep It Simple, Stupid): 가장 단순한 해결책이 가장 좋은 해결책임.
  • 의의: 기술 부채(Technical Debt)의 누적을 방지하고, 대규모 협업 환경에서 코드 리뷰 비용을 획기적으로 낮추며 시스템의 수명을 연장함.

⚠️ 모순 및 업데이트 (Contradictions & Updates)

  • 과거 데이터와의 충돌: 과거에는 메모리와 성능 최적화를 위해 짧고 암호 같은 코드를 선호했으나, 현대 정책은 하드웨어 자원보다 '개발자의 인지적 자원(Cognitive Resource)'을 훨씬 비싼 자산으로 간주하여 가독성을 최우선 정책으로 삼음.
  • 정책 변화: Antigravity 프로젝트는 에이전트가 생성하는 모든 코드에 대해 SOLID 원칙과 클린 코드 가이드라인을 강제 적용하며, 복잡도가 일정 수준 이상인 코드는 자동 리팩토링 루프에 진입시킴.

🔗 지식 연결 (Graph)

  • Software-Architecture-Patterns, Refactoring-Techniques, SOLID-Principles-in-React, Technical-Debt-Management
  • Raw Source: 00_Raw/Clean Code Principles.md

🤖 LLM 활용 힌트 (How to Use This Knowledge)

언제 이 지식을 쓰는가:

  • (TODO)

언제 쓰면 안 되는가:

  • (TODO)

🧪 검증 상태 (Validation)

  • 정보 상태: needs_review
  • 출처 신뢰도: A
  • 검토 이유: (P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)

🧬 중복 검사 (Duplicate Check)

  • 기존 유사 문서: (TODO: 인덱서 클러스터 리포트 참조)
  • 처리 방식: UPDATE (자동 정규화)
  • 처리 이유: Phase 1 정규화 — 옛 템플릿/누락 필드 보강.

🕓 변경 이력 (Changelog)

날짜 변경 내용 처리 방식 신뢰도
2026-05-08 P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) UPDATE A

💻 코드 패턴 (Code Patterns)

패턴 1: (TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)

# TODO

🤔 의사결정 기준 (Decision Criteria)

선택 A를 써야 할 때:

  • (TODO)

선택 B를 써야 할 때:

  • (TODO)

기본값:

(TODO)

안티패턴 (Anti-Patterns)

  • [안티패턴]: (TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)