Cara mengesahkan standard pengekodan di WordPress -PHP

Ketika WordPress dibangunkan, sejak awal, Matt Mullenweg, ketua pengaturcara dan tidak lama lagi menjadi CEO Automattic, syarikat di belakang WordPress, menguatkuasakan senarai panjang peraturan mengenai penulisan kod yang harus dipatuhi oleh setiap penyumbang teras. Peraturan tersebut menentukan bagaimana kod itu akan muncul. Berikut adalah senarai penuh standard kod PHP:
https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/


Piawaian pengekodan sangat penting dalam membangun untuk WordPress dan semua orang dapat menerapkannya ketika mengembangkan untuk WordPress. Tidak menjadi masalah sama ada anda menulis plugin yang disesuaikan untuk tema pelanggan atau anak anda.

Tetapi pertama-tama mari kita bincangkan mengenai standard pengkodan. Mengapa kita mesti menggunakan standard? Pada dasarnya, kod itu mesti berfungsi, bukan? Mengapa ada orang yang perlu peduli jika hanya ada satu ruang di antara klausa syarat atau jika beberapa komen dokumentasi harus dimulai dengan huruf besar dan diakhiri dengan titik noktah?

Piawaian pengekodan sangat umum di hampir setiap kerangka dan sistem. Kod yang ditulis oleh peraturan yang ditentukan dengan baik mempunyai kelebihan besar berbanding kod yang ada’t.

Ia lebih senang dibaca. Apabila kod ditulis oleh beberapa pengaturcara, atau oleh satu programmer dalam jangka masa yang panjang, menjadi sangat sukar untuk dibaca. Ia seperti buku tanpa editor yang ditulis oleh beberapa pengarang. Kaedah peribadi kadang-kadang akan dimulakan dengan awalan garis bawah dan kadang-kadang tidak, kadang-kadang pemboleh ubahnya adalah Camel Casing dan kadang-kadang tidak. Ruang tidak konsisten dan kelihatan seperti kekacauan.

Juga, menggunakan piawaian kod dapat membantu mengurangkan kesalahan. Sebagai contoh, matt, dalam kebijaksanaannya yang tidak terbatas, menyatakan bahawa ‘Keadaan Yoda’ menjadi wajib. Ini bermaksud bahawa bukannya

Sekiranya ($ var === benar)

Anda harus menulis

Sekiranya (benar === $ var)

Kenapa mesti ada yang peduli dengan itu? Kecuali jika anda mempunyai OCD…. Jawapannya mudah. Menggunakan keadaan Yoda mencegah penempatan secara tidak sengaja dalam keadaan, perkara yang boleh membuat anda gila.

Menggunakan piawaian kod menjadikan kod anda kelihatan seperti kod profesional yang padat. Kod yang lulus ujian standard kod, adalah kod kualiti.

Memberitahu pelanggan atau bos anda bahawa anda menulis mengikut piawaian kod WordPress adalah sesuatu yang dapat membantu anda mendapatkan kontrak tersebut atau mendapat kenaikan gaji. Tetapi terdapat jurang besar antara mengatakan bahawa anda bekerja mengikut piawaian dan benar-benar bekerja oleh mereka.

Piawaian kod pada dasarnya adalah senarai yang sangat panjang, dan sukar untuk mengingat semuanya. Jadi, bagaimana kita melakukannya? Juga, bagaimana kita membenarkan pengurus pelanggan mengesahkan bahawa kod tersebut sebenarnya ditulis mengikut piawaian?

Inilah sebabnya mengapa kami mempunyai alat analisis kod Statik PHP yang membolehkan kami mengimbas kod yang kami tulis dan mengesahkan bahawa kod tersebut mengikuti setiap peraturan dalam piawaian.

Menggunakan phpcs agak mudah di linux atau windows. Pertama, anda mesti memasang phpcs melalui PEAR:

$ pir memasang PHP_CodeSniffer

Sahkan pemasangan dengan

$ phpcs -i

Anda harus mendapat sesuatu seperti itu:

Piawaian pengekodan yang dipasang adalah PHPCS, Squiz, PSR2, MySource, PEAR, Zend dan PSR1

Ini membolehkan anda mengimbas kod PHP dengan pelbagai standard PHP yang diketahui. Kita perlu menambah standard WordPress pada alat phpcs. Kami akan membuat beberapa direktori (bukan temporal) sebagai klon padanya projek GitHub dari kamus WordPress phpcs:

$ cd c: \ wpcs

$ git clone -b master https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git wpcs

Selepas itu, kami akan menambahkan kamus WordPress ke phpcs:

$ phpcs –config-set install_paths c: \ path \ to \ wpcs

Sekiranya kita mencuba php –I, kita akan melihat bahawa kamus WordPress ada di sana:

$ phpcs -i
Piawaian pengekodan yang dipasang adalah PHPCS, Squiz, PSR2, MySource, PEAR, Zend, PSR1, WordPress, WordPress-VIP, WordPress-Core, WordPress-Docs dan WordPress-Extra
Menjalankan phpcs agak mudah. Pergi ke direktori kod anda dan ketik ini:

$ phpcs –standard = WordPress ./**/*.php

Itu’betul! Anda akan mendapat laporan mengenai masalah tersebut dengan segera:

FILE: /var/www/html/github/wp-notice/tests/bootstrap.php
———————————————————————-
MENCARI 6 KESALAHAN YANG MEMPENGARUHI 5 GARIS
———————————————————————-
2 | KESALAHAN | [] Komen dokumen fail tiada
4 | KESALAHAN | [x] Syarat pertama penyataan IF berbilang baris mesti
| | secara langsung mengikuti kurungan pembukaan
19 | KESALAHAN | [] Komen dokumen fungsi tiada
19 | KESALAHAN | [] Nama fungsi "_ manual_load_plugin" tidak sah;
| | hanya kaedah persendirian yang harus diawali dengan
| | garis bawah
21 | KESALAHAN | [x] Fail disertakan secara bersyarat; menggunakan "merangkumi"
| | sebaliknya
22 | KESALAHAN | [x] Fail disertakan secara bersyarat; menggunakan "merangkumi"
| | sebaliknya
———————————————————————-
PHPCBF BOLEH MEMPERBAIKI 3 PERLINDUNGAN SNIFF YANG DILETAKKAN secara automatik
———————————————————————-

Mendapatkan laporan kesilapan sifar sebenarnya adalah tujuannya di sini. Mencetak laporan ini kepada pelanggan dan pengurus dapat menunjukkan kepada mereka bahawa anda menulis kod mengikut piawaian dan kod anda sebenarnya lebih berkualiti daripada kod lain.

Anda boleh menjalankan phpcs secara automatik, dan menggunakan alat lain untuk menyelesaikan beberapa masalah secara automatik. Anda bahkan boleh menggabungkan standard dengan IDE anda untuk segera diberitahu. Tetapi sebelum semua ini, mengetahui standard dan mengetahui phpcs dapat meletakkan anda dan kod anda dalam tahap kualiti yang berbeza.

Jeffrey Wilson Administrator
Sorry! The Author has not filled his profile.
follow me
    Like this post? Please share to your friends:
    Adblock
    detector
    map