スキル一覧に戻る
grimmolf

global-commenting

by grimmolf

Soap calculator for Midnight Garden Apothecary with custom additive quality impact calculations

0🍴 0📅 2025年11月5日
GitHubで見るManusで実行

SKILL.md


name: Global Commenting description: Write self-documenting code that explains itself through clear structure and naming, adding only minimal, evergreen comments for complex logic sections. Use this skill when deciding whether code needs comments, removing outdated temporal comments about changes/fixes, or writing concise explanations. Applies to all code files when balancing code clarity with necessary documentation, ensuring comments remain relevant far into the future rather than describing temporary states.

Global Commenting

When to use this skill

  • When deciding whether code needs comments or can be made self-explanatory through better naming
  • When writing comments for complex algorithms or business logic that isn't immediately obvious
  • When removing temporal comments like "fixed bug yesterday" or "TODO: refactor later"
  • When reviewing existing comments to ensure they're still accurate and evergreen
  • When explaining WHY code makes a particular decision rather than WHAT it does
  • When documenting large sections of code logic with concise, helpful summaries
  • When avoiding redundant comments that just restate what the code obviously does
  • When refactoring code to eliminate the need for explanatory comments through clarity
  • When adding comments to configuration files explaining non-obvious settings
  • When documenting workarounds for third-party library quirks or platform limitations
  • When ensuring comments will remain relevant months or years into the future

Global Commenting

This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to how it should handle global commenting.

Instructions

For details, refer to the information provided in this file: global commenting

スコア

総合スコア

50/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です