Hello semua dalam komuniti CodeGym! Hari ini kita akan bercakap tentang kualiti kod. Ya, kawan-kawan yang dikasihi. Tiada sesiapa yang sempurna. Semua orang sedar pada satu ketika bahawa kod itu boleh menjadi lebih baik... Tetapi apa yang perlu dilakukan dalam situasi ini? Sekurang-kurangnya, mula menyelidik isu ini. Tetapi anda sudah berada di sini, bermakna topik itu mesti menarik minat anda, jadi mari pergi. Hari ini kami akan menerangkan cara anda boleh menjadikan kod anda lebih baik dan lebih bersih. Jadi anda tidak akan malu dengan kod semasa anda pada masa hadapan! :) Semua kaedah ini akan membantu seorang pengaturcara untuk menjadi seorang pengaturcara yang baik.
1. Jika anda ingin menambah baik kod anda, baca kod orang lain
Jika anda ingin meningkatkan kemahiran pengaturcaraan anda secara mendadak, anda perlu... membaca kod yang ditulis oleh pengaturcara lain. Percaya atau tidak. Tetapi jika anda mengambil risiko, saya berjanji: anda akan diberi ganjaran untuk masa yang diluangkan. Contohnya, jangan baca di medium.com tentang cara HashMap, ArrayList, LinkedList, dll. berfungsi. Sebaliknya, baca kod sumber mereka dan fikirkan sendiri. Berikut adalah senarai kelas untuk dibaca:
Soalan yang paling kerap ditanya dalam temu bual adalah tentang HashMap. Anda boleh membunuh dua burung dengan satu batu: anda akan memahami kod dan mendapat pengetahuan yang anda perlukan.
Perkara yang sama adalah benar tentang ArrayList. Tidak ada yang rumit, tetapi kod sumber benar-benar bernilai dibaca dan difahami.
String adalah contoh yang sangat baik. Fahami mengapa ia tidak berubah.
AtomicInteger ialah kelas sejuk: ia mentakrifkan operasi atom pada objek Integer.
Selepas itu, kita boleh senaraikan setiap kelas, satu demi satu :)
Lebih serius, anda harus membaca kod dari Pivotal. Orang di sana telah menulis ekosistem yang paling banyak permintaan di dunia Java. Kod mereka pasti bernilai dibaca. Saya syorkan anda mulakan dengan Spring Core . Membaca kod sumber yang tidak dikenali adalah kerja yang sukar tetapi bermanfaat. :)
2. Ikuti konvensyen kod
Konvensyen pengekodan ialah satu set garis panduan yang dibuat oleh pasukan pembangunan. Ia termasuk garis panduan untuk gaya pengekodan dan teknik untuk setiap aspek kod. Konvensyen ini mungkin ditulis untuk keseluruhan syarikat atau untuk projek tertentu. Konvensyen pengekodan secara amnya khusus untuk setiap bahasa pengaturcaraan dan organisasi fail penutup, lekukan, ulasan, pengisytiharan, pengendali, ruang, konvensyen penamaan, teknik dan prinsip pengaturcaraan, peraturan pengaturcaraan, amalan terbaik untuk seni bina dan sebagainya. Faedah utama piawaian tertentu ialah hakikat bahawa kod itu kelihatan sama dan ditulis dalam gaya yang sama. Ini menjadikannya lebih mudah dibaca dan membantu pengaturcara memahami kod yang ditulis oleh pengaturcara lain. Jika piawaian pengekodan diikuti dan digunakan secara konsisten sepanjang proses pembangunan, ia akan menjadi lebih mudah pada masa hadapan untuk mengekalkan dan melanjutkan kod anda, memfaktorkannya semula dan menyelesaikan konflik penyepaduan. Konvensyen pengekodan adalah penting kepada pengaturcara atas beberapa sebab:
40-80% daripada kos perisian pergi ke penyelenggaraannya,
Hampir tidak ada perisian yang diselenggarakan oleh pengarangnya sepanjang hayatnya,
Konvensyen pengekodan meningkatkan kebolehbacaan kod sumber dengan membenarkan pengaturcara memahami kod baharu dengan lebih cepat.
Sejujurnya, saya peminat tegar piawaian pengekodan. Bagi saya, masuk akal untuk meluangkan masa berbincang dan berhujah tentang mereka, kerana ia adalah aktiviti berharga yang akan menjimatkan masa dan usaha anda pada masa hadapan. Konvensyen kod harus disemak dengan kerap. Peraturan boleh ditukar daripada "diperlukan" kepada "pilihan" dan sebaliknya. Jika sesetengah daripada mereka tidak berfungsi seperti yang diharapkan, ia harus disemak atau dialih keluar daripada garis panduan.
3. Gunakan ulasan kod
Semakan kod ialah salah satu alat yang paling berkuasa untuk penambahbaikan kod. kenapa? Kerana kod itu akan dilihat oleh pakar yang tidak menulisnya. Dan penampilan yang segar sangat berguna. Dan semakan kod selalunya membantu menghalang penulisan kod yang benar-benar mengerikan. Saya tahu bahawa semakan kod tidak selalu boleh dilakukan, kerana anda perlu mencari orang lain yang sanggup melakukannya. Tetapi itu tidak bermakna anda harus melangkau menggunakan alat ini. Sebaliknya: ulasan kod adalah sebab untuk mencari orang yang berfikiran sama yang juga perlu meningkatkan kualiti kod mereka. By the way, siapa yang akan menghalang anda daripada mencari mereka di sini di CodeGym? Di tempat di mana semua orang mahu menjadi seorang pengaturcara.
4. Tulis ujian unit
Teknik kegemaran saya untuk menambah baik kod pastinya menulis ujian unit. Lebih banyak daripada mereka yang anda tulis, lebih baik. Dalam pengaturcaraan komputer, ujian unit ialah proses pembangunan perisian di mana sekeping kod sumber yang boleh diuji terkecil, dipanggil unit, diuji secara individu dan bebas untuk melihat sama ada ia berfungsi seperti yang diharapkan. Ini akan membantu anda menemui kegagalan dalam algoritma dan/atau logik anda sebelum anda mengeluarkan kod anda. Oleh kerana ujian unit memerlukan kod anda distrukturkan dengan sewajarnya, kod mesti dibahagikan kepada fungsi yang lebih kecil dan lebih fokus. Setiap satu bertanggungjawab untuk operasi tunggal pada set data, dan bukannya fungsi besar yang melaksanakan beberapa operasi berbeza ( prinsip tanggungjawab tunggalbertanya khabar...). Faedah kedua menulis kod yang diuji dengan baik ialah anda boleh mengelak daripada memecahkan kod apabila membuat perubahan kecil pada fungsi sedia ada. Apabila ujian unit gagal, mereka akan memberitahu anda bahawa sesuatu telah ditulis dengan tidak betul. Pada pandangan pertama, masa pembangunan yang digunakan untuk menulis ujian unit kelihatan seperti kos tambahan. Walau bagaimanapun, ujian unit akan menjimatkan masa pada penyahpepijatan pada masa hadapan. Ini sepatutnya menjadi proses langkah demi langkah. Jadi mari kita lebih ke hadapan dengan senyuman — kita akan menulis ujian untuk setiap kaedah dan kelas :D
5. Gunakan alatan untuk meningkatkan kualiti kod
Tidak ada pembangun yang tidak pernah melakukan kesilapan. Biasanya, pengkompil menangkap masalah sintaks dan aritmetik dan memaparkan surih tindanan. Tetapi beberapa masalah mungkin masih muncul yang tidak dapat ditangkap oleh pengkompil. Contohnya, keperluan yang tidak dilaksanakan dengan betul, algoritma yang salah, kod yang tidak berstruktur atau beberapa masalah berpotensi lain yang diketahui oleh komuniti daripada pengalaman. Satu-satunya cara untuk menangkap ralat seperti ini ialah meminta pembangun yang lebih senior menyemak kod anda, bukan? Tetapi pendekatan ini bukanlah ubat penawar dan tidak akan banyak berubah. Untuk setiap pembangun baharu dalam pasukan, anda harus mempunyai sepasang mata tambahan untuk melihat kodnya. Nasib baik, terdapat banyak alat di luar sana yang boleh membantu anda mengawal kualiti kod anda. Saya telah menggunakan Checkstyle, PMD, FindBugs dan SonarQube dalam kerja saya pada pelbagai projek. Dan ada yang lain juga. Kesemuanya biasanya digunakan untuk menganalisis kualiti kod dan menjana beberapa laporan berguna. Selalunya laporan ini diterbitkan oleh pelayan penyepaduan berterusan seperti Jenkins.
6. Tulis kod yang ringkas dan mudah
Sentiasa tulis kod yang mudah, mudah difahami dan logik. Orang ramai cenderung untuk menulis kod yang rumit untuk membuktikan mereka boleh melakukannya. Kod mudah dan logik sentiasa berfungsi dengan baik, membawa kepada lebih sedikit masalah dan lebih boleh diperluaskan. Kod yang baik ialah dokumentasi terbaik. Jika anda berfikir untuk menambah ulasan, tanya diri anda: "Bagaimanakah saya boleh menambah baik kod supaya ulasan ini tidak diperlukan?" - Steve McConnell.
7. Baca dokumentasi
Salah satu tabiat terpenting pengaturcara yang baik ialah membaca banyak dokumentasi. Sama ada spesifikasinya, JSR, dokumen API, tutorial atau sesuatu yang lain, dokumentasi membaca membantu anda membina asas yang kukuh untuk pengaturcaraan terbaik anda. Akhir sekali, jangan bandingkan diri anda dengan orang lain. Membandingkan diri anda dengan orang lain hanya akan membawa kepada perasaan negatif dan persaingan yang tidak sihat. Setiap orang mempunyai kekuatan dan kelemahan masing-masing. Ini bermakna adalah penting untuk mengenali mereka dan bekerjasama dengan mereka. Ambil inventori diri anda — senaraikan kekuatan anda dan lakukannya. Pengaturcaraan adalah keseronokan sebenar: nikmatinya.
"Pemalar seorang lelaki ialah pembolehubah lelaki lain."
8. Ikuti blogger yang menarik
Beribu-ribu peminat di seluruh dunia bekerja dengan dan menulis tentang teknologi yang sama. Blog selalunya ditulis oleh pengaturcara sendiri, dan kebanyakannya berkongsi pendapat dan pengalaman peribadi. Melalui blog, anda boleh melihat perspektif yang berbeza mengenai teknologi yang sama. Anda boleh melihat kedua-dua teknologi baik dan buruk di blog. Sekurang-kurangnya, baca artikel di Blog Coding Dojo dan CodeGym :) Ikuti blog yang bagus dan komen pada siaran, kongsi pendapat anda.
9. Baca buku tentang profesion
Tiada apa yang boleh menggantikan buku yang bagus. Buku yang bagus mengajar konsep asas dalam bentuk yang lebih mudah dan terpakai kepada perkara di dunia nyata. Pengarang mereka sendiri adalah pengaturcara yang hebat. Dengan membaca buku, anda boleh belajar daripada pengalaman orang lain. Saya cadangkan anda membaca "Jawa Berkesan" Joshua Bloch. Buku ini membentangkan tujuh puluh lapan peraturan praktikal yang sangat diperlukan untuk pengaturcara: penyelesaian kerja terbaik untuk masalah pengaturcaraan yang anda hadapi setiap hari. Ia mengandungi garis panduan yang paling praktikal dan berwibawa untuk menulis program yang berkesan dan direka dengan baik. Jika anda baru bermula dengan Java dan tidak mempunyai pengalaman pengaturcaraan, anda boleh membaca "Sams Teach Yourself Java 2 in 24 Hours". Dan untuk menulis kod bersih, terdapat buku yang sangat baik, "Kod Bersih", oleh Robert Martin. Selepas membacanya,
10. Kod! Kod! Kod!
Anda tidak boleh menjadi seorang pengaturcara yang baik hanya dengan menghafal buku. Mudah untuk bercakap tentang konsep teori. Tetapi anda hanya boleh mempelajari batasan bahasa atau melaksanakan amalan terbaik apabila anda menulis kod. Oleh itu, untuk menjadi seorang pengaturcara yang baik, anda perlu menulis banyak kod. Jika anda seorang pemula, mulakan dengan menulis program untuk tugasan mudah seperti siri Fibonacci, palindrom, segitiga Pascal, dll. Kemudian beralih kepada tugas yang lebih besar seperti pepohon carian binari, dsb. Jika anda sedang mencari platform dalam talian untuk mempraktikkan Java program, lihat Coding Ground . Bekerja dengan cara anda melalui kursus pengaturcaraan dan saya jamin bahawa kemahiran anda akan menjadi lebih baik. Pilihan lain ialah mengambil kursus Harvard CS50, yang percuma.
Mari kita ringkaskan
Orang yang tidak melakukan kesalahan adalah orang yang tidak melakukan apa-apa. Itulah sebabnya kami mengekalkan kesabaran kami dan, seperti belalang yang rajin, kami mengasah kemahiran pengekodan kami. Untuk melakukan ini, jangan lupa:
Baca kod orang lain
Sediakan dan minta ulasan kod
Tulis ujian unit
Gunakan alatan untuk menambah baik kod anda
Tulis kod yang mudah dan mudah difahami
Baca dokumentasi yang ditulis oleh mereka yang boleh
Hari ini kita akan bercakap tentang kualiti kod. Ya, kawan-kawan yang dikasihi. Tiada sesiapa yang sempurna. Semua orang sedar pada satu ketika bahawa kod itu boleh menjadi lebih baik... Tetapi apa yang perlu dilakukan dalam situasi ini? Sekurang-kurangnya, mula menyelidik isu ini. Tetapi anda sudah berada di sini, bermakna topik itu mesti menarik minat anda, jadi mari pergi. Hari ini kami akan menerangkan cara anda boleh menjadikan kod anda lebih baik dan lebih bersih. Jadi anda tidak akan malu dengan kod semasa anda pada masa hadapan! :) Semua kaedah ini akan membantu seorang pengaturcara untuk menjadi seorang pengaturcara yang baik.
Konvensyen pengekodan ialah satu set garis panduan yang dibuat oleh pasukan pembangunan. Ia termasuk garis panduan untuk gaya pengekodan dan teknik untuk setiap aspek kod. Konvensyen ini mungkin ditulis untuk keseluruhan syarikat atau untuk projek tertentu. Konvensyen pengekodan secara amnya khusus untuk setiap bahasa pengaturcaraan dan organisasi fail penutup, lekukan, ulasan, pengisytiharan, pengendali, ruang, konvensyen penamaan, teknik dan prinsip pengaturcaraan, peraturan pengaturcaraan, amalan terbaik untuk seni bina dan sebagainya. Faedah utama piawaian tertentu ialah hakikat bahawa kod itu kelihatan sama dan ditulis dalam gaya yang sama. Ini menjadikannya lebih mudah dibaca dan membantu pengaturcara memahami kod yang ditulis oleh pengaturcara lain. Jika piawaian pengekodan diikuti dan digunakan secara konsisten sepanjang proses pembangunan, ia akan menjadi lebih mudah pada masa hadapan untuk mengekalkan dan melanjutkan kod anda, memfaktorkannya semula dan menyelesaikan konflik penyepaduan. Konvensyen pengekodan adalah penting kepada pengaturcara atas beberapa sebab:
kenapa? Kerana kod itu akan dilihat oleh pakar yang tidak menulisnya. Dan penampilan yang segar sangat berguna. Dan semakan kod selalunya membantu menghalang penulisan kod yang benar-benar mengerikan. Saya tahu bahawa semakan kod tidak selalu boleh dilakukan, kerana anda perlu mencari orang lain yang sanggup melakukannya. Tetapi itu tidak bermakna anda harus melangkau menggunakan alat ini. Sebaliknya: ulasan kod adalah sebab untuk mencari orang yang berfikiran sama yang juga perlu meningkatkan kualiti kod mereka. By the way, siapa yang akan menghalang anda daripada mencari mereka di sini di CodeGym? Di tempat di mana semua orang mahu menjadi seorang pengaturcara.
Sentiasa tulis kod yang mudah, mudah difahami dan logik. Orang ramai cenderung untuk menulis kod yang rumit untuk membuktikan mereka boleh melakukannya. Kod mudah dan logik sentiasa berfungsi dengan baik, membawa kepada lebih sedikit masalah dan lebih boleh diperluaskan. Kod yang baik ialah dokumentasi terbaik. Jika anda berfikir untuk menambah ulasan, tanya diri anda: "Bagaimanakah saya boleh menambah baik kod supaya ulasan ini tidak diperlukan?" - Steve McConnell.
Salah satu tabiat terpenting pengaturcara yang baik ialah membaca banyak dokumentasi. Sama ada spesifikasinya, JSR, dokumen API, tutorial atau sesuatu yang lain, dokumentasi membaca membantu anda membina asas yang kukuh untuk pengaturcaraan terbaik anda. Akhir sekali, jangan bandingkan diri anda dengan orang lain. Membandingkan diri anda dengan orang lain hanya akan membawa kepada perasaan negatif dan persaingan yang tidak sihat. Setiap orang mempunyai kekuatan dan kelemahan masing-masing. Ini bermakna adalah penting untuk mengenali mereka dan bekerjasama dengan mereka. Ambil inventori diri anda — senaraikan kekuatan anda dan lakukannya. Pengaturcaraan adalah keseronokan sebenar: nikmatinya.
