Skip to content

chore(starter): 不要コメント整理 + docs/ AR 作業履歴削除(公開ノイズ排除)#192

Merged
shunei-web merged 1 commit into
v1.2from
chore/v1.2-comment-audit-2026-04-30
Apr 30, 2026
Merged

chore(starter): 不要コメント整理 + docs/ AR 作業履歴削除(公開ノイズ排除)#192
shunei-web merged 1 commit into
v1.2from
chore/v1.2-comment-audit-2026-04-30

Conversation

@shunei-web
Copy link
Copy Markdown
Collaborator

目的

starter v1.2 リファレンス実装としての規範性を v1.0 公開リリース前に確保する。コードコメントから書籍・spec 領域の内容を排除し、starter 固有情報のみを残す。

走査スコープ

全 HTML / CSS / JS(src/ 配下)+ docs/ 削除

結果サマリ

分類 件数
削除 4 行(D6 Block 役割説明 × 3 カテゴリ)
短縮 5 箇所(D5 WCAG 基準番号 × 2 + 内部参照/D6 部分除去 × 3)
要判断 0 件
docs/ 削除 1 ファイル(AR 作業履歴)

削除カテゴリ別内訳

D6 Block 役割説明(DEVIATION コメントへの付記)

ファイル 削除内容
c-skip-link.css 「アクセシビリティ対応のスキップリンク。キーボード操作のフォーカス時のみビューポート左上に表示される。」2 行
c-overlay.css 「汎用オーバーレイ。ドロワー・モーダル・ライトボックス等で再利用可能。」1 行
c-back-to-top.css 「ページ上部へ戻る機能を持つ、ビューポート右下に常駐する固定配置ボタン。」1 行

D5 WCAG 基準番号(短縮)

ファイル:行 Before After
c-form.css L14 /* Element: note — フォーム冒頭の必須マーク説明(WCAG 3.3.2 Labels or Instructions) */ /* Element: note — フォーム冒頭の必須マーク説明 */
c-form.css L59 /* Foundation の :where(:focus-visible) outline リングを温存(WCAG 2.4.11 AA) */ /* Foundation の :focus-visible outline リングを温存 */

内部番号参照除去 / D6 部分除去(短縮)

ファイル Before After
p-hero.css 4 行コメント(「原則 9 の明示理由付き例外」内部参照 + Block 役割説明含む) 1 行: /* l-inner p-hero__inner 併記により .p-hero の grid 直接子になったため grid-area を宣言 */
p-problem.css 「2-level 構造: li に c-card.-subtle + c-text-block を併記。装飾は...が担当)。」 他の空ルール placeholder と形式統一: /* スタイルなし(HTML クラスとの対応を維持。c-card.-subtle + c-text-block の Block+Element 併記) */
main.js JSDoc 「LCP 要素の FOIC 防止に使用」 「ファーストビュー要素のアニメーション遅延防止に使用」

スコープ B: docs/ 削除

  • docs/ar-2026-04-30-v12-finishing.mdgit rm
    • 理由: cortex/sessions/2026-04-30.md に AR 結果記録済。テンプレートリポに AR 作業履歴を公開するのはノイズ

HTML コメント

全 CUSTOMIZE / 構造セクションラベル / NOTE で 8 ルール準拠。削除対象なし。

CSS コメント(残した判断)

  • DEVIATION コメント(c-skip-link / c-overlay / c-back-to-top): Rule 2 → 残す
  • 空ルール placeholder 「スタイルなし(...)」: Rule 3 → 残す
  • Element コメント(c-form の各 Element): Rule 4 → 残す
  • 公開 API コメント: Rule 6 → 残す
  • show() vs showModal() の判断(p-drawer.css): Rule 8 → 残す
  • [data-visible] は JS 付与の説明(c-back-to-top.css): Rule 5 → 残す
  • c-form の子孫 <a> 説明(Reset unset 対策): Rule 8 → 残す

検証

  • pnpm run check(stylelint / markuplint / eslint): ✅ 通過
  • pnpm run build: ✅ 成功(built in 69ms)

8+6 ルールに従い、スターターリポの公開コードから書籍・spec 領域のコメントを排除。

削除 (D6 Block 役割説明):
- c-skip-link.css: DEVIATION コメントに付記されていた「アクセシビリティ対応のスキップリンク。...」2 行
- c-overlay.css: 「汎用オーバーレイ。ドロワー・モーダル・ライトボックス等で再利用可能。」1 行
- c-back-to-top.css: 「ページ上部へ戻る機能を持つ、...」1 行

短縮 (D5 WCAG 基準番号):
- c-form.css L14: 「WCAG 3.3.2 Labels or Instructions」を除去
- c-form.css L59: 「WCAG 2.4.11 AA」を除去

短縮 (内部番号参照 / D6 部分除去):
- p-hero.css: 「原則 9 の明示理由付き例外」等の内部 memory 参照を除去、技術的 WHY のみ 1 行に圧縮
- p-problem.css: 「装飾は c-card.-subtle、タイポの縦積みは c-text-block が担当」を除去、他の空ルール placeholder と形式を統一
- main.js JSDoc: 「LCP 要素の FOIC 防止に使用」を「ファーストビュー要素のアニメーション遅延防止に使用」に短縮(D5)

スコープ B:
- docs/ar-2026-04-30-v12-finishing.md を git rm(cortex/sessions/2026-04-30.md に AR 結果記録済、テンプレートリポでは公開ノイズ)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying starter with  Cloudflare Pages  Cloudflare Pages

Latest commit: 88b08dd
Status: ✅  Deploy successful!
Preview URL: https://edd88b07.starter-20t.pages.dev
Branch Preview URL: https://chore-v1-2-comment-audit-202.starter-20t.pages.dev

View logs

@shunei-web shunei-web merged commit c767d72 into v1.2 Apr 30, 2026
2 checks passed
@shunei-web shunei-web deleted the chore/v1.2-comment-audit-2026-04-30 branch April 30, 2026 14:25
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