Foto: Boskampi / Pixabay
Proyek google/styleguide merupakan repositori resmi yang memuat kumpulan konvensi dan panduan gaya penulisan kode untuk proyek perangkat lunak sumber terbuka yang berasal dari Google. Repositori ini ditujukan bagi pengembang yang memelihara proyek Google maupun tim rekayasa perangkat lunak yang membutuhkan rujukan konvensi penulisan kode yang rapi dan teruji. Dengan menerapkan standar ini, pemeliharaan basis kode berskala besar menjadi lebih mudah dikelola karena setiap berkas ditulis dengan format yang seragam.
Standar Konvensi dan Manfaat Praktis
Setiap proyek perangkat lunak skala besar membutuhkan panduan konvensi yang jelas untuk menjaga keterbacaan kode. Lingkup panduan dalam google/styleguide mencakup berbagai aturan praktis, mulai dari format penamaan variabel menggunakan camelCase, larangan variabel global, hingga pertimbangan penggunaan fitur bahasa tertentu seperti pengecualian penanganan galat.
Repositori ini merupakan salinan dari aturan internal Google untuk membantu pengembang eksternal yang berkontribusi pada proyek open source milik Google. Dokumen-dokumen panduan di dalamnya dirilis di bawah lisensi Creative Commons Attribution 3.0 (CC-By 3.0), yang memperbolehkan pengguna untuk membagikan dan mengadaptasi isinya secara bebas.
Berikut adalah beberapa fitur dan cakupan panduan utama yang tersedia di dalam repositori:
- Panduan gaya bahasa pemrograman lengkap yang mencakup C++, Python, Java, Go, TypeScript, JavaScript, C#, Shell, Swift, Objective-C, R, Haskell, Common Lisp, serta Vim script.
- Panduan penataan format dokumen dan data untuk HTML/CSS, JSON, dan Markdown.
- Panduan Desain Format Dokumen XML (XML Document Format Style Guide) yang mengulas aturan pembuatan format berkas XML baru, perbandingan perancangan format mandiri versus format yang sudah ada, serta panduan pemilihan elemen versus atribut.
- Berkas konfigurasi editor bawaan
google-c-style.elyang siap digunakan untuk pengguna editor Emacs yang menulis kode C++. - Rujukan ke panduan eksternal resmi Google lainnya, seperti Angular Style Guide, Effective Dart, dan Kotlin Style Guide.
- Referensi standar penulisan pesan commit Git guna menjaga riwayat version control system (VCS) tetap bersih dan informatif dalam jangka panjang.
Perlu diperhatikan bahwa repositori ini memprioritaskan kebutuhan internal Google, sehingga kontribusi eksternal berupa pull request tidak diterima dan akan ditutup tanpa komentar. Namun, pengguna tetap dapat membuka isu di pelacak isu GitHub untuk menyampaikan pertanyaan atau perbaikan teknis.
Cara Mengakses dan Memanfaatkan Panduan
README pada repositori ini tidak memuat instruksi instalasi paket melalui command line karena proyek ini berwujud kumpulan dokumentasi acuan serta berkas konfigurasi teks. Untuk mulai mempelajarinya, ikuti langkah-langkah berikut:
- Kunjungi situs resmi panduan di https://google.github.io/styleguide/ untuk menelusuri daftar dokumen gaya penulisan per bahasa pemrograman.
- Buka pedoman bahasa pemrograman yang Anda gunakan, seperti C++ Style Guide atau Python Style Guide, lalu terapkan konvensi tersebut ke dalam standar tim kerja Anda.
- Jika Anda menggunakan editor teks Emacs untuk memprogram C++, Anda dapat mengunduh berkas konfigurasi
google-c-style.ellangsung dari repositori untuk menerapkan indentasi dan aturan format secara otomatis. - Apabila proyek Anda membutuhkan perkakas linter otomatis untuk memeriksa gaya kode C++, README menyarankan untuk menggunakan fork komunitas di https://github.com/cpplint/cpplint, karena perkakas cpplint bawaan internal sudah tidak diperbarui secara publik di repositori ini.
Penggunaan Singkat
README repositori ini tidak menyertakan contoh sintaks kode program mandiri. Pengembang dapat merujuk langsung ke dokumen spesifik masing-masing bahasa pemrograman pada laman web atau berkas markdown di dalam repositori untuk melihat contoh implementasi konvensi kode serta aturan penulisan pesan commit VCS.
Pelajari dokumentasi lengkapnya melalui google/styleguide on GitHub dan situs resmi Google Style Guides.