Saya bagian dari tim pengembang Java dengan tenggat waktu 6 minggu. Ini mengharuskan penulisan banyak kode dengan sangat cepat. Namun tim pengembangan kami memiliki gaya pengkodean yang berbeda. Semuanya, mulai dari konvensi nama hingga metode abstraksi berbeda di antara tim kami. Apakah ada yang tahu ada dokumen yang menentukan "standar" untuk java?
Untuk memperjelas, saya bertanya-tanya apakah ada organisasi yang akan menentukan konvensi penamaan yang tepat untuk variabel dan fungsi misalnya. Ini sangat penting karena dengan tenggat waktu yang singkat kami tidak dapat menghabiskan waktu untuk mencoba memahami kode satu sama lain.
java
coding-standards
Daniel Gratzer
sumber
sumber
Saya benar-benar menandai jawaban Andres , dan fokus pada aspek seragam memformat kode java.
Jika Anda menggunakan Eclipse, Anda dapat mengatur formatter Java-nya untuk secara otomatis memformat ke standar Java. Formatter Eclipse juga memiliki pengaturan bermanfaat lainnya, seperti karakter per baris (yaitu berapa banyak karakter per baris sebelum dipecah menjadi baris baru), dan banyak lainnya. Standarisasi karakter per baris membuat lebih mudah untuk diff kode yang ditulis oleh pengembang yang berbeda tanpa banyak perbedaan hanya dari jarak dan line break.
Terakhir, dengan Eclipse, setelah Anda mengatur semua pengaturan yang Anda inginkan, kemudian ekspor formatter Anda sebagai file yang dapat diimpor oleh setiap anggota tim. Jadi jika Anda menggunakan Eclipse, saya sangat merekomendasikan sepenuhnya mengeksplorasi semua opsi itu akan memformat otomatis dan mengedit kode untuk Anda, dan kemudian berbagi pengaturan dengan seluruh tim.
Saya akan menganggap IDE java utama lainnya (IntelliJ dan Netbeans) memiliki fitur serupa untuk mengekspor pengaturan format.
sumber
Sebenarnya. Itu bukan yang terpenting.
Setelah 30 tahun sebagai konsultan, saya telah membaca banyak kode dari banyak pelanggan. Penting untuk dicatat bahwa setiap pelanggan (dan sering dalam organisasi pelanggan) ada gaya yang berbeda-beda.
Setelah membaca begitu banyak gaya, saya belajar ini.
Gaya Tidak Peduli
Harap fokus pada penulisan kode yang selalu berfungsi, dan penulisan unit test yang membuktikan bahwa itu selalu berhasil.
Setelah Anda mengirimkan kode kerja, Anda dapat mendandaniya jika Anda kehabisan bug untuk diperbaiki dan perangkat tambahan untuk dipasang.
sumber
Jangan khawatir tentang memilih standar universal yang sempurna. Yang Anda butuhkan hanyalah tim Anda menyetujui satu standar dan berpegang teguh pada itu. Rias sendiri jika Anda mau, tetapi tetaplah konsisten.
Konsistensi meningkatkan kolaborasi, kolaborasi meningkatkan kode.
Sekalipun konsistensi yang sebenarnya tidak membantu, fakta bahwa tim Anda bekerja bersama untuk mencapai kesepakatan adalah Hal Baik. Ketidakmampuan mereka untuk menyetujui sesuatu yang sederhana seperti konvensi pengkodean mengatakan mungkin ada masalah kerja tim yang lebih besar bersembunyi di bawah permukaan.
sumber
Sun Java CC yang disebutkan di atas tidak hanya berusia 13 tahun dan beberapa aturannya sudah usang (seperti 80 karakter per baris), tetapi juga tidak mendefinisikan konvensi penamaan, kecuali yang paling umum (selubung unta untuk kelas, blok huruf besar) untuk variabel akhir statis dan sejenisnya).
Anda perlu mendefinisikan standar Anda sendiri untuk berbagai jenis kelas, seperti DAO, EJBs, entitas, apa pun yang Anda gunakan. Sun Java CC seperti kelas dasar abstrak yang dimaksudkan untuk memperluas :)
sumber
Seperti yang disebutkan oleh orang lain di sini, Anda dapat mencari secara online 1 dari beberapa 'panduan gaya' populer untuk Jawa dan membujuk semua orang di tim untuk menaatinya. Beberapa alat pengecekan kode di IDE favorit Anda mungkin dapat membantu mengingatkan Anda ketika Anda tidak melakukannya.
Namun, terkadang politik terlibat. Saya pernah berada dalam situasi di mana pengembang paling senior dalam tim terus melakukannya dengan caranya sendiri bahkan setelah seseorang menyebutkan perlunya standarisasi. Dalam situasi seperti itu, mungkin lebih baik untuk mengamati gaya kodenya dan mengikutinya karena dia mungkin memiliki pengetahuan paling banyak tentang basis kode dan persyaratan dan Anda mungkin tidak ingin membuang waktu menginjak jari kakinya meskipun ia sedang sulit. Itulah yang kami lakukan dalam situasi khusus itu dan dengan enggan saya ikuti.
Jadi, penting untuk mempertimbangkan situasi Anda juga.
sumber
Paman Bob menunjukkan gaya pengkodean yang lebih modern dan terkini dalam bukunya "Clean Code". Sayangnya tidak mengandung daftar item. Anda harus membacanya. Dia mengatakan pada dirinya sendiri bahwa untuk melihat konvensi, Anda harus membaca kode-nya. Paman Bob tidak diragukan lagi semacam institusi. Buku ini adalah bacaan yang sangat bagus, jadi meskipun sudah terlambat untuk membacanya sekarang, bacalah segera.
sumber
Yang benar-benar penting dalam kode adalah kompleksitas siklomatik yang rendah, cakupan kecil, kohesi tinggi dan pilihan pengidentifikasi ekspresif. Mengingat itu, kode menjadi mudah dipahami dan kode seperti itu bagus.
Saya sarankan Anda melihat Pemrograman Spartan .
Kebanyakan standar pengkodean memberi tahu Anda cara membuat kode yang ditulis dengan buruk terlihat cantik dan sebagian besar diskusi tentang "gaya pengkodean" sebenarnya tentang pemformatan. Pemformatan kode adalah tentang yang secara visual mewakili struktur kode Anda. Itu sepele dan otomatis dan hampir tidak melakukan apa pun dengan gaya pengkodean, karena gaya pengkodean bukan tentang bagaimana Anda mewakili struktur kode, tetapi tentang bagaimana Anda menyusun kode.
Ada juga banyak perang agama tentang konvensi penamaan, meskipun sebenarnya itu hanya hack untuk mengatasi desain yang buruk. Nama itu baik, jika dikatakan apa artinya. Semakin kecil dan semakin jelas cakupan Anda, semakin mudah untuk memilih nama tersebut.
sumber