Bagaimana anda bekerja dengan kod orang lain ' s?

Berurusan dengan kod yang dicipta oleh orang lain adalah kemahiran asas untuk pemaju. Berikannya setahun dan kod orang lain juga boleh menjadi milik anda sendiri.

Hari ini saya akan melihat beberapa pendekatan terbaik untuk bagaimana menangani kod orang lain, membaca kod warisan, dengan berkesan. Ia bukan topik yang mudah untuk diliputi.

Untuk membuat proses lebih mudah, saya membingkai pendekatan saya melalui kawasan berikut:

Interact
Perhatikan
Jalankan ujian
Betulkan pepijat yang direka untuk pendatang baru
Cari sumber yang tersedia
Gunakan IDE yang baik
Baca Buku & Blog
menyumbang kepada dokumentasi
menjadi perhatian
Mari kita mulakan.

Takeaways Key

Memahami kod orang lain adalah kemahiran asas bagi pemaju. Untuk memudahkan proses ini, pemaju harus berinteraksi dengan pemaju utama dan ahli pasukan lain, memerhatikan dan membiasakan diri dengan pangkalan kod, menjalankan ujian, dan menetapkan pepijat yang direka untuk pendatang baru.
pemaju harus menggunakan sumber yang ada, termasuk arkib senarai mel, dokumentasi projek, dan sejarah kawalan versi. IDE yang baik juga boleh memberi manfaat dalam memahami dan bekerja dengan kod orang lain.
Pembelajaran dari orang lain melalui buku, blog, dan sumber lain dapat membantu pemaju mengelakkan kesilapan yang sama dan meningkatkan kemahiran mereka. Menyumbang kepada dokumentasi juga boleh menjadi pengalaman pembelajaran yang berharga.
Adalah penting untuk menjadi perhatian apabila bekerja dengan kod orang lain. Memahami bahawa pemaju yang berbeza mungkin mempunyai pendekatan yang berbeza dan tahap kemahiran dapat memupuk persekitaran kerja yang lebih hormat dan produktif.

Interact

siapa pemaju utama? Di mana mereka? Adakah mereka boleh didapati secara langsung di pejabat anda? Jika ya, pergi bercakap dengan mereka atau e -mel kepada mereka. Orang -orang ini harus menjadi sumber pengetahuan terbaik tentang sesuatu projek.

Adakah anda pekerja terpencil atau freelancer? Apakah saluran komunikasi yang dimiliki oleh projek atau syarikat? Adakah pemaju di IRC, Slack, Twitter, E -mel, Trello atau yang lain?

Pastikan anda berada di mana mereka berada. Kritikan yang sering disamakan di Zend Framework 2 adalah bahawa tidak ada komuniti aktif. Itu bukan kes itu, kerana saluran IRC aktif setiap hari. Oleh itu, pastikan anda berada di mana pemaju dan ahli pasukan lain.

Perhatikan

Apabila anda mula -mula memulakan projek, ambillah mudah pada diri sendiri. Jangan mengharapkan untuk mengetahui segala -galanya dari awal. Anggaran berbeza -beza, tetapi saya pernah mendengar tiga minggu hingga tiga bulan kerja sehari -hari dengan kod sebelum pemaju boleh benar -benar dianggap produktif dengan asas kod tersebut.

Sesetengah orang mempunyai persepsi yang sesat yang anda boleh, entah bagaimana, hanya melompat masuk dan dengan serta -merta menjadi produktif. Mungkin mereka menonton terlalu banyak filem Hollywood seperti Swordfish.

codebases mengambil masa untuk belajar kerana mereka dilaburkan dengan idea , prasangka , kepercayaan dan pendekatan semua pemaju yang bekerja di projek itu. Memandangkan anda baru, anda tidak akan mempunyai pengetahuan latar belakang.

Berikut adalah 5 cara yang baik untuk memulakan:

• luangkan masa untuk melangkah melalui segala -galanya
• Tanya soalan
• Persediaan Pemasangan Ujian
• cuba menggunakan pemasangan ujian
• baca melalui komen kod dan dokumentasi yang berkaitan

Jangan bersungguh -sungguh pada diri sendiri, berikan diri anda peluang untuk membuat permulaan yang baik. Selepas beberapa ketika, anda akan mula mempunyai pemahaman yang lebih baik tentang bagaimana permohonan itu telah disatukan.

Pada ketika ini, mula bergerak lebih cepat dengan bertanya soalan pemaju lain dan pemaju kanan. Anda akan membina senarai soalan semasa anda melalui codebase.

Luangkan masa untuk meminta pemaju lain untuk menjawab soalan dan pertanyaan anda. Jangan malu, lompat masuk dan dapatkan jawapan dan input yang anda perlukan.

Jalankan ujian

Sebarang asas kod yang baik harus mempunyai ujian. Jika tidak, itu bukan tanda yang baik. Ia tidak perlu berbahaya - ia hanya boleh menjadi pemaju atau pasukan pembangunan yang tidak pernah melaksanakan ujian - tetapi saya akan lebih sedikit bimbang jika tidak ada.

Jika terdapat ujian, jalankannya. Adakah mereka lulus? Saya telah menjumpai lebih daripada satu sumber kod sumber yang mempunyai ujian yang tidak dapat dijalankan. Adakah mereka telah dikemas kini?

Sekarang anda telah cuba menjalankannya, baca dengan baik melalui mereka. Sekiranya mereka ditulis dengan baik, mereka harus menerangkan bagaimana aplikasi berfungsi, apa yang diharapkan untuk dilakukan, dan bagaimana komponen yang berbeza menggantung bersama. Pastikan anda meluangkan masa untuk melakukan ini, kerana ia boleh menjadi sangat berwawasan.

Betulkan pepijat yang direka untuk pendatang baru

Satu lagi cara mudah untuk memulakan adalah menetapkan pepijat yang disasarkan kepada pendatang baru, atau lebih banyak pemaju junior, pada projek itu. Dua contoh yang baik ialah Joind.in dan OwnCloud, pelacak bug untuk yang terakhir yang anda dapat lihat dalam tangkapan skrin di bawah.

Anda dapat melihat tiket -tiket ini telah ditandakan dengan jelas. Mempunyai bacaan dan terlibat. Pepijat ini tidak akan menjadi sangat teknikal, tetapi anda akan dapat meringankan projek, membina keyakinan dan pengetahuan anda.

Walaupun kerumitan kemuliaan dan teknikal boleh menjadi baik untuk ego, apabila perkara tidak berfungsi atau mengambil masa yang lama, mereka tidak melakukan apa -apa nikmat untuk kebanggaan dan semangat anda. Mulakan kecil dan meringankan jalan anda.

Cari sumber yang tersedia

Salah satu perkara terbaik yang boleh anda lakukan apabila mengambil alih pangkalan kod, atau ketika masuk ke dalam pasukan yang ada, adalah untuk mengumpulkan seberapa banyak sumber yang dapat anda lakukan. Tidak pasti apa yang perlu dicari? Berikut adalah beberapa idea untuk memulakan anda:

• Adakah anda mempunyai akses ke arkib senarai mel?
• Adakah terdapat projek atau syarikat wiki?
• Dokumentasi projek apa yang telah disusun?
• adakah anda membaca sejarah kawalan versi?
• Mempunyai penyumbang yang ditulis mesej komitmen yang bermakna, secara konsisten ?

Gunakan IDE yang baik

Ide yang baik bernilai berat pepatah mereka dalam emas. Sama ada anda ruby ​​, python , pergi , java , php atau pemaju bahasa lain, cari IDE yang baik sama ada khusus khusus untuk atau sesuai disesuaikan untuk bahasa pilihan anda. Saya menghargai sesetengah orang adalah pemurni, lebih suka Vim atau Emacs, dan itu OK. Tetapi saya seorang kekasih IDE dan pilihan saya adalah phpstorm. Terdapat banyak yang lain, seperti Eclipse, Textmate, Sublimetext, dan VisualStudio.

Sebaik sahaja anda menemui IDE untuk anda, mula menggunakan ciri -ciri yang ditawarkannya. Saya akan merujuk kepada phpstorm secara khusus di sini, tetapi gunakan prinsip -prinsip ini untuk pilihan anda.

Mula melangkah melalui kod dan lihat jika ia mematuhi standard. Ini tidak perlu menjadi standard formal, seperti PSRS PHP. Tetapi adakah pemaju mengikuti gaya yang konsisten, atau di seluruh tempat. Gunakan alat seperti pengesan kekacauan dan penguji kerumitan siklomatik untuk mula mengukur kualiti kod.

Adakah terdapat dokumentasi kod? Jika ya, IDE anda boleh menggunakannya semasa anda memeriksa kod tersebut. Seterusnya, gunakan debugger langkah-langkah, seperti XHPROF, XDEBUG atau ZEND DEBUGGER, dan jalankan aplikasi, melihat bagaimana ia berfungsi.

apa yang dilakukannya? Apakah struktur data yang dibuat dan digunakan? Adakah ia mengulangi blok kod tidak perlu? Terdapat jauh lebih banyak daripada yang saya boleh tutup di sini, tetapi gunakan ciri -ciri IDE yang anda sediakan semasa anda melalui kod untuk menjadikan hidup anda lebih mudah. ​​

baca dan belajar

Yang satu ini adalah pendirian untuk saya secara peribadi. Semakin kita belajar, semakin banyak kita dapat berkembang dan - akibatnya - lakukan. Kami bukan orang pertama yang menginjak jalan yang kami lakukan. Ramai, banyak, yang lain telah datang di hadapan kami dan membuat banyak kesilapan yang sama yang kami mungkin buat.

Simpan diri anda sedikit masa dan lakukan keadilan untuk pengalaman yang sukar dipelajari dengan belajar dari mereka. Begitu banyak pemaju yang lebih baik juga penulis dan blogger.

Salah satu kegemaran peribadi saya ialah Martin Fowler, yang juga telah menerbitkan sebuah buku hebat mengenai topik refactoring. Terdapat juga buku -buku yang sangat baik, seperti corak reka bentuk, dan laman web seperti sourcemaking.com.

Buat diri anda dan terus melabur dalam sumber seperti ini. Ia tidak selalunya mudah, tetapi ia boleh memberi ganjaran yang luar biasa.

menyumbang kepada dokumentasi

Ini adalah yang saya tidak cukup. Sangat mudah untuk menjadi pengkritik kerusi, duduk di luar dan mengkritik codebase, rangka kerja atau projek perisian lain. Daripada melakukan itu, masuk dan terlibat.

Dokumentasi

bukan untuk pengaturcara, pereka atau orang bukan teknikal yang gagal. Beberapa projek terbesar secara aktif mencadangkan bahawa tempat terbaik untuk memulakan adalah dokumentasi.

Salah satu projek yang paling menonjol yang melakukan ini adalah kernel Linux. Apa cara yang lebih baik untuk belajar sesuatu daripada mendokumenkannya? Lagipun, jika anda benar -benar tahu, maka anda boleh mendokumentasikannya.

Jadi jika ia adalah projek sumber terbuka, masuk, cari tahu, baca melalui kod, buat nota semasa anda pergi, kemudian menyumbang kepada dokumentasi. Jika ia adalah aplikasi dalaman, jadilah yang pertama untuk mula mendokumentasikan; walaupun tidak ada orang lain kecuali diri anda.

Mungkin tidak ada dokumentasi untuk dibicarakan; tempat yang benar -benar mengerikan. Tetapi setiap projek perlu bermula di suatu tempat. Semasa anda bekerja melalui kod sumber, tuliskan apa yang anda tahu.

Beberapa pemaju terbaik yang saya tahu, contohnya Lorna Jane yang indah, mula blog dengan cara ini. Dia blog untuk menyimpan rekod tentang apa yang dia sedang belajar, yang kemudiannya masuk ke salah satu blog PHP yang paling popular di sekitar.

menjadi perhatian

Titik Terakhir: Berhati -hati dengan pemaju yang kerja anda mengkaji dan membina. Anda tidak tahu di mana mereka berada dalam kerjaya dan pendidikan mereka, atau apa sekatan yang mereka ada pada mereka, apabila mereka menulis kod yang kini anda akan datang untuk mempercepatkan.

Lebih -lebih lagi, pada tahap kemahiran anda berada? Ia boleh menjadi mudah bagi kita, apabila kita masih muda, lebih baru, dan kurang berpengalaman, untuk menghakimi orang lain.

Kami fikir kami tahu semuanya dan jangkaan, konsep dan pendekatan kami adalah cara yang benar dan betul untuk pergi. Tetapi adakah itu benar -benar berlaku? Saya suka mempercayai bahawa, ketika kita matang, dan tumbuh sedikit lebih tua, kita juga semakin bijak dan menjadi lebih menerima pelbagai pendekatan untuk pembangunan perisian yang wujud.

kita mungkin tidak perlu bersetuju dengan mereka, tetapi mereka tidak semestinya salah. Mereka mungkin mempunyai banyak untuk mengajar kita, yang dapat membantu kita berkembang. Jadi selalu cuba dan perhatian orang lain dan kedudukan mereka berada. Jangan menjadi pendatang baru yang menjengkelkan, menunjuk jari dan menyalahkan. Lagipun, itu tidak membantu siapa pun, terutama anda.

membungkus

Terdapat banyak lagi yang boleh anda lakukan untuk membuat kerja dengan kod orang lain proses yang lebih mudah diurus. Kaedah, petua, helah dan alat apa yang anda gunakan?

Soalan Lazim (Soalan Lazim) Mengenai Bekerja Dengan Kod Orang Lain

Apakah strategi untuk memahami kod orang lain? Walau bagaimanapun, terdapat beberapa strategi yang boleh anda gunakan untuk menjadikan proses lebih mudah. Pertama, cuba dapatkan pemahaman peringkat tinggi mengenai kod dengan membaca dokumentasi atau komen yang ada. Seterusnya, pecahkan kod itu ke bahagian yang lebih kecil, terkawal dan cuba memahami setiap bahagian secara individu. Menggunakan debugger juga boleh membantu, kerana ia membolehkan anda melangkah melalui kod dan melihat bagaimana ia berfungsi. Akhirnya, jangan teragak -agak untuk bertanya kepada pengarang asal atau ahli pasukan lain untuk mendapatkan bantuan jika anda terjebak. adalah teknik di mana dua pengaturcara bekerja bersama di satu stesen kerja. Satu, pemandu, menulis kod sementara yang lain, pemerhati atau navigator, mengkaji setiap baris kod seperti yang ditaip. Kedua -dua pengatur ini menukar peranan dengan kerap. Pendekatan ini menggalakkan pemahaman yang lebih baik tentang kod tersebut, kerana kedua -dua pengaturcara boleh membincangkan dan menjelaskan sebarang keraguan atau isu dalam masa nyata. Ia juga membantu dalam menangkap kesilapan awal, kerana pemerhati dapat melihat kesilapan yang mungkin dilewatkan oleh pemandu. Cara yang jelas dan logik dapat membantu orang lain dalam memahaminya. Sesetengah strategi untuk menganjurkan kod termasuk pengelompokan fungsi berkaitan bersama -sama, menggunakan nama yang bermakna untuk pembolehubah dan fungsi, dan memberikan komen untuk menerangkan bahagian kompleks kod. Ia juga penting untuk mengikuti konvensyen dan piawaian pengekodan yang ditetapkan, kerana mereka menyediakan struktur yang konsisten yang menjadikan kod lebih mudah dibaca dan difahami. 🎜> Pengulas kod bertanggungjawab untuk mengkaji semula kod yang ditulis oleh ahli pasukan lain untuk memastikan ia memenuhi piawaian kualiti pasukan. Ini termasuk memeriksa kesilapan, memastikan kod mengikuti konvensyen pengekodan yang ditetapkan, dan mengesahkan bahawa ia mencapai fungsi yang dimaksudkan. Pengulas Kod juga memberi maklum balas kepada pengarang asal, yang dapat membantu mereka meningkatkan kemahiran pengekodan mereka. adalah kemahiran yang boleh diperbaiki dengan amalan. Mulailah dengan membaca dan memahami kod yang ditulis oleh orang lain, dan cuba mengenal pasti teknik dan strategi yang mereka gunakan. Mengambil bahagian dalam ulasan kod dan sesi pengaturcaraan pasangan, kerana ini memberikan peluang untuk belajar dari orang lain dan mendapatkan perspektif yang berbeza. Di samping itu, mengkaji piawaian pengekodan dan amalan terbaik juga boleh membantu meningkatkan kemahiran anda.

Alat apa yang boleh membantu saya dalam memahami dan bekerja dengan kod orang lain?

Terdapat beberapa alat yang dapat membantu anda dalam memahami dan bekerja dengan kod orang lain. Persekitaran Pembangunan Bersepadu (IDE) sering mempunyai ciri -ciri yang dapat membantu anda menavigasi kod dan memahami strukturnya. Debuggers membolehkan anda melangkah melalui kod dan melihat bagaimana ia berfungsi. Alat semakan kod boleh membantu anda mengenal pasti isu dan memberi maklum balas. Di samping itu, alat dokumentasi dapat membantu anda memahami tujuan dan fungsi Kod. boleh menggunakan. Mulailah dengan cuba memahami struktur dan fungsi keseluruhan kod. Gunakan debugger untuk melangkah melalui kod dan lihat bagaimana ia berfungsi. Jika boleh, tanya pengarang asal atau ahli pasukan lain untuk penjelasan. Semasa anda mendapat pemahaman, pertimbangkan untuk menambah komen atau dokumentasi anda sendiri untuk membantu pemaju masa depan. untuk menghormati Kod dan Konvensyen Pengekodan yang sedia ada. Mulakan dengan memahami asas kod dan strukturnya. Pastikan perubahan anda sejajar dengan kod sedia ada dan jangan mengganggu fungsinya. Uji perubahan anda dengan teliti untuk memastikan mereka tidak memperkenalkan pepijat baru. Akhirnya, berkomunikasi dengan pasukan anda dan mengambil bahagian dalam ulasan kod untuk memastikan perubahan anda difahami dan diterima. kerana mereka memastikan konsistensi dan kebolehbacaan di seluruh codebase. Mereka menentukan bagaimana kod harus ditulis dan dianjurkan, yang memudahkan ahli pasukan memahami dan bekerja dengan kod masing -masing. Piawaian pengekodan juga membantu mengekalkan kualiti kod, kerana mereka sering memasukkan garis panduan untuk pengendalian, keselamatan, dan prestasi ralat. Komunikasi adalah kunci apabila bekerja dengan pasukan di pangkalan kod. Jelas dan ringkas apabila membincangkan kod, dan gunakan istilah teknikal yang sesuai. Mengambil bahagian dalam ulasan kod dan memberikan maklum balas yang membina. Jika anda menghadapi masalah memahami sekeping kod, jangan ragu untuk meminta penjelasan. Juga, terbuka untuk menerima maklum balas dan gunakannya untuk meningkatkan kemahiran pengekodan anda.

Atas ialah kandungan terperinci Bagaimana anda bekerja dengan kod orang lain ' s?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!