mcpField
C
clean-code

clean-code

github.com/pproenca開発220845 回インストール11 週間前に更新
リポジトリ

clean-code について

ソフトウェア開発者向けの Clean Code ガイドです。Robert C. Martin の著作を基に現代の修正を加え、言語を問わない原則をまとめています。

主な機能

  1. 0110 分野のコーディング項目
  2. 02影響度順のルール
  3. 03命名、関数、エラー処理の指針
  4. 04オブジェクト、境界、システム設計の解説
  5. 05ユニットテストとシンプルな設計

活用シーン

  1. 01関数やクラスの作成・リファクタリング
  2. 02コードの保守性レビュー
  3. 03ユニットテストの改善
  4. 04サードパーティ依存のラップ

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/pproenca/dot-skills --skill clean-code

インストール後、Claude Code で/clean-codeを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

metadata.json
assets/templates/
_template.md
references/
_sections.md
bound-learning-tests.md
bound-wrap-third-party.md
class-cohesion.md
class-isolate-from-change.md
class-organize-for-change.md
class-separate-concerns.md
class-small.md
cmt-avoid-commented-out-code.md
cmt-avoid-redundant.md
cmt-explain-intent.md
cmt-express-in-code.md
cmt-warning-consequences.md
emerge-expressiveness.md
emerge-simple-design.md
err-avoid-null.md
err-define-by-caller-needs.md
err-provide-context.md
err-use-exceptions.md
err-write-try-catch-first.md
fmt-horizontal-alignment.md
fmt-indentation.md
fmt-team-rules.md
fmt-vertical-formatting.md
func-abstraction-level.md
func-command-query-separation.md
func-dry.md
func-minimize-arguments.md

詳細

Robert C. Martin（Uncle Bob）のクリーンコードのベストプラクティス

Robert C. Martin の著書『Clean Code: A Handbook of Agile Software Craftsmanship』に基づく、包括的なソフトウェア開発の職人技ガイドです。2008年当時の助言が現在では適用されなくなった箇所には、現代的な修正を加えています。コードレビュー、リファクタリングの判断、新規開発の指針となるよう、影響度順に優先順位を付けた10カテゴリ、48のルールを収録しています。例は主に Java で示していますが、原則は言語に依存しません。

適用するタイミング

次のような場合に、これらのガイドラインを参照してください。

  • 新しい関数、クラス、モジュールを書くとき
  • 変数、関数、クラス、ファイルに名前を付けるとき
  • 保守性の問題についてコードをレビューするとき
  • 明瞭さを高めるため、既存のコードをリファクタリングするとき
  • 単体テストを書く、または改善するとき
  • サードパーティの依存関係をラップするとき

優先度別のルールカテゴリ

優先度カテゴリ影響度プレフィックス
1意味のある名前CRITICALname-
2関数CRITICALfunc-
3コメントHIGHcmt-
4書式HIGHfmt-
5エラー処理HIGHerr-
6オブジェクトとデータ構造MEDIUM-HIGHobj-
7境界MEDIUM-HIGHbound-
8クラスとシステムMEDIUM-HIGHclass-
9単体テストMEDIUMtest-
10創発とシンプルな設計MEDIUMemerge-

クイックリファレンス

1. 意味のある名前（CRITICAL）
2. 関数（CRITICAL）
3. コメント（HIGH）
4. 書式（HIGH）
5. エラー処理（HIGH）
6. オブジェクトとデータ構造（MEDIUM-HIGH）
7. 境界（MEDIUM-HIGH）
8. クラスとシステム（MEDIUM-HIGH）
9. 単体テスト（MEDIUM）
10. 創発とシンプルな設計（MEDIUM）

使用方法

詳しい説明とコード例については、各リファレンスファイルをお読みください。

リファレンスファイル

ファイル説明
references/_sections.mdカテゴリーの定義と順序
assets/templates/_template.md新しいルール用のテンプレート
metadata.jsonバージョンとリファレンス情報

コメント

Markdown 対応