Bagaimanakah anda membuat pembantu AI mengikuti konvensi pengekodan projek anda?

Question

Accepted Answer

AI secara lalai menggunakan purata umum data latihan, jadi untuk mendapatkan **gaya anda** anda harus **menunjukkan dan menguatkuasakan** — melalui contoh, fail peraturan eksplisit, dan gelung linter yang menangkap apa yang terlepas. Jangan bergantung pada AI untuk meneka piawaian anda (WordPress Coding Standards, PSR-12, dsb.).

## Teknik (mengikut leverage)

- **Sediakan konfigurasi linter dan contoh** — tampal `.eslintrc`, `phpcs.xml`, atau `.editorconfig` anda. Ini adalah peraturan dalam bentuk yang boleh disemak mesin, dan AI dapat membacanya.
- **Simpan fail peraturan/arahan** — `CLAUDE.md` atau prompt sistem yang menyatakan piawaian secara eksplisit: "Projek ini mengikuti **PSR-12**. Gunakan indentasi 4 ruang, kurungan pada baris seterusnya untuk fungsi, snake_case untuk cangkuk." Arahan tetap mengalahkan mengulangi diri setiap prompt.
- **Tunjukkan kod sedia ada yang mewakili** — satu atau dua fail bersih mengajar penamaan, struktur, dan idiom lebih cepat daripada mana-mana penerangan. AI mencocokkan corak apa yang dilihat.
- **Jalankan linter pada output AI dan maklum balas kesilapan** — langkah paling boleh dipercayai. Linter adalah kebenaran; tampal ralat dan minta AI untuk membetulkan.

## Gelung linter

```bash
# 1. AI generates the change, then you run the project linter on it:
phpcs --standard=phpcs.xml src/NewClass.php
# => src/NewClass.php  12 | ERROR | Expected 1 space after FUNCTION keyword; 0 found
#    src/NewClass.php  14 | ERROR | Line indented incorrectly; expected 4 spaces, found 2

# 2. Paste those exact errors back to the AI: "Fix these phpcs errors."
# 3. Re-run until clean. The linter — not the AI's claim — is the source of truth.
```

Gelung ini menumpu dengan cepat kerana linter memberikan maklum balas tepat di peringkat baris yang boleh diambil tindakan oleh AI secara langsung, daripada anda menerangkan gaya dalam prosa.

## Mengapa ia penting

Kod yang mengabaikan konvensi projek mewujudkan **geseran ulasan dan ketidakkonsistenan** walaupun ia betul dari segi fungsi — pengulas membuang masa pada pemformatan, dan pangkalan kod terseret. AI tidak mempunyai kesedaran tentang gaya rumah anda melainkan anda membekalnya, jadi kerja adalah menjadikan peraturan **eksplisit dan boleh disemak**: fail peraturan untuk niat, kod mewakili untuk idiom, dan linter sebagai penegak dalam gelung. Disiplin yang sama (config + contoh + pemeriksaan automatik) adalah cara anda memasuki ahli pasukan manusia ke konvensi anda, juga.