Mengapa kami membutuhkan standar dan cara menerapkannya – panel admin cepat

Tab atau spasi? OK Spaces, tapi kemudian 2 atau 4 spasi? Beberapa dari Anda mungkin akan menjawab “tidak masalah, itu masih akan berhasil”. Biarkan saya menebak, Anda mungkin bekerja sendiri, bukan dalam tim pengembang? Penyebab segera setelah ada banyak orang yang mendorong kode, perlu ada standar pengkodean. Artikel ini akan menunjukkan kepada Anda cara mengadopsinya.

Mari kita mulai dengan contoh sederhana.

class ChangePasswordController extends Controller {

    public function edit() {
        return view('profile.password.edit');
    }

}

atau

class ChangePasswordController extends Controller 
{
    public function edit() 
    {
        return view('profile.password.edit');
    }
}

Perhatikan perbedaan di atas? {Braket ada di baris baru, untuk nama kelas dan fungsi edit (). Bukan masalah besar, katamu?

Tetapi jika kita mengikuti standar PHP paling populer PSR-2/PSR-12, kode kedua adalah yang benar-itu harus menjadi baris baru.

---

Apa masalah sebenarnya jika kode tidak diformat?

Seperti yang saya katakan di atas, penataan kode tidak menjadi masalah jika Anda bekerja sendiri, dan tidak ada orang lain yang akan mengedit kode Anda di masa depan.

Tetapi untuk proyek yang serius, jika mereka tumbuh, maka tim kemungkinan akan berkembang. Belum lagi proyek open-source yang mungkin memiliki ratusan kontributor.

Sekarang, bayangkan Anda bekerja di tim dan dorong kode yang diformat dengan cara apa pun yang Anda inginkan, tanpa melihat standar apa pun.

Dan rekan setim Anda menarik kode itu untuk membuat beberapa perubahan. Tapi dia mengkode standar dan IDE -nya memformat kode secara otomatis (nanti saya akan menunjukkan cara melakukannya).

Lalu apa yang terjadi – dia mendorong kode dengan perubahan, dan komitmen itu memiliki dua hal:
-Banyak format ulang kode
– dan kemudian kode utama komit

Lihat tangkapan layar dari SourceTree – ini bisa menjadi komit dengan perbaikan kecil:

Hanya tiga baris kode yang terkait dengan perbaikan aktual, yang lainnya adalah “noise”. Sangat sulit untuk dibaca untuk siapa saja yang ingin meninjau kode atau menemukan dalam sejarah apa yang diubah tepatnya.

Dengan kata lain, jika rekan tim yang berbeda menggunakan standar pengkodean yang berbeda (atau tidak sama sekali), maka kode akan penuh dengan performa ulang atau, bahkan lebih buruk, kode yang diformat secara berbeda di tempat yang berbeda.

Ini mungkin terdengar seperti non-masalah, tetapi bayangkan memiliki font yang berbeda dalam dokumen kata besar. Itu masih bisa dibaca, tetapi tidak menyenangkan.

---

Apa itu gaya/standar kode dan mengapa PSR-2/PSR-12?

Standar kode menjelaskan aturan seperti:

• Tab atau spasi? 2 spasi atau 4 spasi? Jawaban yang benar adalah 4 spasi (Ngomong -ngomong, video lucu dari acara TV “Silicon Valley”)
• Simbol “{” untuk metode – di baris yang sama atau garis terpisah? (Jawaban adalah baris terpisah)
• Apakah kita harus menyatakan publik/pribadi untuk semua properti kelas? (Ya)
• Nama Metode: “Snake_Case” atau “Camelcase”? (Camelcase)

Dalam bahasa PHP, untuk waktu yang lama, standar yang paling populer adalah PSR-2. Pada Agustus 2019, digantikan oleh PSR-12 yang menjadi standar baru.

Tetapi keduanya sangat mirip, PSR-12 adalah semacam PSR-2 yang diperluas, diadaptasi dengan sintaks PHP modern. Jadi Anda dapat menemukan PSR-2 di artikel yang lebih lama, dan PSR-12 di yang lebih baru.

Juga, PSR-12 berkembang pada standar pengkodean dasar yang disebut PSR-1.

Secara umum, baik standar PSR-12 dan PSR-1 adalah dokumen yang sangat panjang dan Anda tidak perlu mengetahui semua aturannya. Tapi saya mendorong Anda untuk membaca kedua standar setidaknya sekali dan mencatat beberapa pertanyaan yang paling banyak digunakan.

---

Bagaimana cara memformat ulang kode dalam hitungan detik dengan IDE?

Saya katakan tidak perlu mempelajari aturannya, sebagian karena ada alat yang mereformasi kode untuk kami.

Lihat screencast cepat apa yang bisa dilakukan dengan phpstorm dengan menggunakan menu Kode -> Kode Ulangatau hanya jalan pintas Cmd + shift + l:

Anda dapat membaca lebih lanjut tentang pemformatan ulang kode di phpstorm di sini dan di sini.

Bagaimana cara memberi tahu phpstorm, gaya kode apa yang akan diadopsi? Itu dapat dilakukan di jendela modal preferensi, di Editor -> Gaya Kode -> PHPlalu pilih “Set dari” dan pilih gaya Anda, saya sarankan PSR-12.

Melihat: Tangkapan layar dan pintasan di sini adalah untuk pengguna Mac, lihat dokumen phpstorm untuk windows.

Juga, saya yakin format seperti itu ada di IDE lain seperti Sublime Text, Vs Code dan lainnya. Jadi silakan cari dalam dokumentasi mereka.

---

Alat pemformatan kode

Juga, ada alat untuk secara otomatis memformat banyak file di semua proyek Anda, Anda juga dapat melampirkan proses penyebaran Anda – jadi format semua file baik secara lokal, atau di server.

---

Tolong tolong, dorong perubahan format dalam komit terpisah

Pesan terakhir. Apa pun metode pemformatan kode yang Anda gunakan, jika Anda perlu memformat ulang file yang ada dan mendorongnya ke repositori, silakan lakukan di a komit terpisah.

Jika dilakukan secara manual, Anda dapat melakukannya dalam urutan seperti itu:

• Membuat kode berubah dan melakukan kode
• Klik “Kode Format” di phpStorm dan jika ada perubahan – berkomitmen dengan pesan “pemformatan kode”

Ini juga dapat diotomatisasi dengan alat yang disebutkan di atas.

---

Kesimpulan

Styling dan format kode adalah bagian dari pekerjaan yang efektif dalam suatu tim. Jadi, jika Anda ingin membuat hidup lebih mudah bagi rekan satu tim Anda, tolong setujui standar kode dan beradaptasi bersama.