Dokumen standar pengkodean bermanfaat. Ini sangat berguna ketika itu cukup singkat sehingga siapa pun dapat mengingat semuanya tanpa terlalu banyak kesulitan dan ketika itu tidak menyebabkan orang terlalu sakit.
Bagaimana Anda memilih untuk indentasi kode di organisasi Anda, atau kapitalkan nama, atau laksanakan loop Anda, atau komentar kode Anda tidak terlalu penting; bagian yang membantu adalah membuat semua orang untuk menulis kode yang hampir sama dengan orang lain.
- Ini menghindari harus menghabiskan satu menit mengkalibrasi ulang harapan Anda tentang di mana kawat gigi seharusnya dan setiap kali Anda melihat kode orang lain.
- Itu menghindari beberapa gaya kode yang berbeda semua dalam file yang sama.
- Mungkin yang paling penting, memiliki standar tertulis menghindari argumen tentang praktik pengkodean selama ulasan kode.
Sekali lagi, apa standarnya tidak masalah sebanyak memiliki standar sederhana dan langsung. Jadi, letakkan semua pengembang Anda di ruangan dan biarkan mereka berdebat tentang standar apa yang seharusnya. Pertemuan ini bisa berlangsung tanpa batas waktu, jadi aturannya adalah:
- Apa pun yang tidak diputuskan pada akhir pertemuan akan diputuskan oleh manajer.
- Pertemuan akan berakhir setelah dua jam, atau ketika seseorang mulai berteriak atau menangis, mana yang lebih dulu.
- Seluruh standar akan pas (dalam ukuran tipe yang masuk akal!) Pada selembar atau dua kertas, hanya dua sisi jika benar-benar diperlukan.
Pertimbangkan mengadopsi seseorang | lagi | standar baik sebagai titik awal untuk pertemuan standar pengkodean Anda sendiri, atau sebagai cara untuk menghindari rapat sepenuhnya.
Setelah disepakati, pengembang harus dapat (dan diharapkan) mengawasi sendiri. Penyimpangan sesekali dari standar seharusnya tidak menjadi masalah besar (dan bahkan mungkin dapat dibenarkan), tetapi penolakan yang tegas untuk meninggalkan beberapa gaya pribadi favorit demi standar harus mengakibatkan relokasi langsung ke kantor dengan pipa air bocor, atau apa pun .
Demian Brecht menunjuk ke alat serat. Ini adalah pelengkap sempurna untuk dokumen standar pengkodean. Hanya baik untuk tetap berpegang pada standar gaya pengkodean ; sangat penting untuk tetap berpegang pada standar pengkodean yang terkait dengan praktik berbahaya. Tidak ada orang selain penulis yang akan memeriksa bahwa setiap baris kode memenuhi standar untuk gaya, tetapi Anda harus mempertimbangkan membangun alat serat ke dalam alur kerja tim Anda untuk secara otomatis menangkap kemungkinan bug. Selain itu, alat itu sendiri dapat mengodifikasi praktik yang diterima sehingga Anda tidak harus membuat daftar semuanya secara individu dalam standar pengkodean; cukup tentukan konfigurasi alat.
Catatan: Gagasan "standar pengkodean" tidak unik untuk pemrograman. "Standar pengkodean" digunakan di banyak bidang, kadang-kadang dalam suatu organisasi, lebih sering di seluruh industri atau profesi. Beberapa contoh:
Dalam setiap kasus (dan banyak lainnya) seorang praktisi yang kompeten dapat dengan mudah memahami "kode" yang tidak memenuhi standar yang diharapkan. Mengapa begitu banyak industri tetap menulis persyaratan terperinci untuk dokumen yang bahkan tidak perlu diuraikan oleh kompiler? Karena gaya itu penting . Menyajikan informasi dalam gaya standar memungkinkan pembaca fokus sepenuhnya pada konten, membuat membaca lebih cepat dan membantu pemahaman, dan mengurangi kesalahan.