Skip to content

docs(paul): 주석은 JSDoc 규격(요약 한 줄 + 표준 태그)만 쓰게 한다 - #29

Merged
yungblud merged 1 commit into
mainfrom
docs/jsdoc-only-comments
Oct 1, 2026
Merged

yungblud merged 1 commit into
mainfrom
docs/jsdoc-only-comments

Conversation

@yungblud

@yungblud yungblud commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

무엇을

  • paul-taste 「주석」 정본 재작성 — // · /* */ 금지, JSDoc 은 요약 한 줄 + (필요 시) 이유 한 줄 + 표준 태그만. 산문 JSDoc ❌/✅ 예시 추가
  • NORMS.md §0.25 문구 갱신 + paul-taste 포인터
  • "주석으로 남긴다" 던 곳을 JSDoc 으로 정렬 — paul-nodejs(@file) · react-native.md · paul-stack · paul-review
  • version 0.29.0 → 0.29.1

왜

JSDoc 만 허용했더니 JSDoc 안에 서술형 문단을 길게 쓰는 일이 생겼다. 형식까지 규격으로 묶는다.

검증

  • python3 scripts/validate-assets.py 통과
  • node hooks/inject-norms.js 단독 실행 통과

🤖 Generated with Claude Code

@yungblud
yungblud merged commit 9cf92a9 into main Oct 1, 2026
4 checks passed
@yungblud
yungblud deleted the docs/jsdoc-only-comments branch October 1, 2026 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant