it-swarm-id.com

Haruskah saya menunjukkan kesalahan terkait ejaan / tata bahasa dalam kode seseorang?

Saat meninjau kode rekan kerja, saya menemukan beberapa kesalahan ejaan dalam nama fungsi dan juga kesalahan tata bahasa seperti doesUserHasPermission() alih-alih doesUserHavePermission() dalam fungsi dan nama variabel.

Haruskah saya tunjukkan ini padanya atau saya terlalu sombong dengan memperhatikan ini?

109
Rahul

Kode dengan kesalahan ejaan dan tata bahasa adalah tidak dapat dipertahankan .

  • Orang tidak akan mengingat tata bahasa yang buruk, jadi mereka akan mencoba memanggil fungsi seperti yang seharusnya ditulis, dan begitulah bug terjadi.

  • Anda tidak dapat menerima sesuatu dalam kode jika Anda tidak tahu bagaimana mengejanya.

  • Sebagian besar orang yang membuat tata bahasa/ejaan melakukannya secara tidak konsisten, sehingga mereka akan memperkenalkan banyak bug dengan penamaan yang tidak cocok. Ini khususnya bermasalah dalam bahasa yang tidak mengharuskan variabel untuk secara eksplisit dideklarasikan sebelum digunakan, karena Anda dapat memperkenalkan ejaan baru dan kode Anda tidak akan berhenti untuk memberi tahu Anda bahwa Anda mengacaukannya.

Memperbaiki masalah-masalah ini bukanlah hal yang rumit, juga tidak diharuskan terutama oleh pendapat orang lain tentang kecerdasan, melek huruf, dll. (Walaupun itu adalah efek samping yang besar); ini tentang menulis kualitas, kode dapat dikelola.

210
HedgeMage

Iya tentu saja. Lebih mudah mengingat nama jika secara tata bahasa benar. Mencoba mengingat nama dan kesalahan tata bahasa adalah hal yang sama sekali berbeda.

39
Jason Baker

Jangan tunjukkan sebagai cacat dalam tinjauan kode formal. Alih-alih, tandai daftar dan bicarakan dengan PRIVATELY tentang mereka. Jadilah diplomatis mungkin tentang hal itu, hanya "Hei, sesuatu yang saya perhatikan, dan saya telah bertemu dengan orang-orang yang BENAR-BENAR meremehkan hal semacam ini, mereka pikir itu membuat programmer terlihat ceroboh dan ceroboh."

Jika ini kode yang ingin dilihat pelanggan, itu benar-benar HARUS diperbaiki. Suka atau tidak, itu TIDAK mencerminkan reputasi perusahaan Anda.

Untuk contoh yang Anda berikan, saya curiga ini dimulai sebagai UserHasPermission, dan orang lain mengatakan kepadanya bahwa praktik lokal adalahUserBlahBlah () daripada UserBlahBlah (), dan ia hanya mengabaikan perubahan tata bahasa.

28
John R. Strohm

bah sendiri.

Semoga Anda berada di lingkungan di mana kode "kepemilikan" tidak menjadi masalah. Jika Anda memiliki akses ke proyek dalam kontrol sumber, cukup masuk dan perbaiki sendiri. Jika Anda melihat rekan kerja tertentu membuat jenis kesalahan tata bahasa atau pengejaan yang sama secara konsisten, Anda mungkin ingin menunjukkannya, tetapi itu akan tergantung pada hubungan Anda, apakah orang itu penutur asli bahasa Inggris, dan daya penerimaan mereka secara umum. Tetapi apakah Anda pernah memutuskan untuk melakukan itu atau tidak, diam-diam pergi dan lakukan perbaikan. Saya melakukan ini sepanjang waktu, jika saya melihat kesalahan ketik, terutama dalam metode tanda tangan atau properti publik, saya hanya memperbaikinya. Kadang-kadang saya bahkan tidak bisa menahan godaan untuk memperbaiki kesalahan ketik dalam komentar, tapi itu hanya saya :)

10
Marcie

Saya kira nilainya menyebutkan di sini bahwa header pengarah HTTP dalam protokol HTTP salah eja sebagai "pengarah" (dan kita harus hidup dengannya/kita telah belajar untuk hidup dengannya)) :)

6
Bunny Rabbit

Saya seorang pengembang yang bahasa ibunya bukan bahasa Inggris, itu sebenarnya bahasa Belanda, dan tidak akan keberatan sama sekali jika seseorang akan menunjukkan kesalahan tata bahasa atau ejaan kepada saya. Dengan cara itu saya dapat terus meningkatkan bahasa Inggris saya. Dan tentu saja tidak sulit untuk memperbaiki semua kesalahan dalam semua kode sumber Anda. Script Perl sederhana dapat dengan mudah ditulis untuk loop melalui semua file dalam folder. Mungkin bahkan bisa dilakukan dengan sed? Saya tidak tahu.

Jadi saya pasti akan menunjukkan kesalahan tata bahasa atau ejaan dalam kode orang lain, tetapi hanya jika saya benar-benar yakin apakah itu benar apa yang saya katakan.

6
user11317

Saya setuju dengan jawaban lain yang mengatakan bahwa kode dengan kesalahan tata bahasa tidak dapat dipertahankan.

Saya juga ingin menambahkan beberapa hal:

  • Kode sering ditulis oleh orang yang tidak berbicara bahasa Inggris dengan baik dan/atau bahasa Inggris bukan bahasa ibu mereka. Jika ada kesalahan tata bahasa dalam kode yang Anda tinjau, ini tidak berarti rekan kerja Anda membuat kesalahan ini. Mungkin itu hanya salin-tempel dari situs web.
  • Jika bahasa Inggris bukan bahasa asli rekan kerja Anda, mungkin ide yang baik, atau sangat buruk untuk memberitahunya tentang kesalahan ini. Berasal dari Prancis, saya selalu menyambut komentar tentang kesalahan yang saya buat dalam bahasa Inggris, karena itu satu-satunya cara saya dapat menghindari mereka di masa depan; di sisi lain, saya tahu beberapa orang yang merasa sangat terluka jika Anda memberi tahu mereka tentang kesalahan tata bahasa yang mereka buat.
  • Seperti yang dikatakan John R. Strohm, jangan pernah melakukannya secara terbuka. Sebagian besar orang akan sangat terganggu dengan ini.
4
Arseni Mourzenko

Saya akan merekomendasikan menggunakan IDE dengan pemeriksa ejaan built-in. IntelliJ Idea melakukan pekerjaan yang bagus untuk program Java. Ada banyak kesalahan ketik yang ditangkapnya, tidak hanya dalam nama fungsi, tetapi dalam mis. pesan pengecualian yang dapat dilihat pengguna. Program yang menghasilkan pesan yang penuh kesalahan ketik tidak menginspirasi banyak kepercayaan diri.

2
Roman Zenka

Ini adalah kesalahan kecil dalam kode, tetapi merupakan kesalahan. Perlakukan itu seperti kesalahan lain yang Anda temukan. Kebijakan saya adalah selalu berasumsi bahwa rekan kerja saya kompeten dan memperlakukan mereka seperti itu sampai mereka membuktikan sebaliknya.

Jika itu adalah satu kesalahan, saya mungkin memperbaikinya dan memeriksanya. Jika itu adalah pola, saya mungkin akan mulai meminta rekan kerja itu untuk meninjau perbaikan tersebut. Biarkan mereka tahu bahwa Anda pikir mereka adalah pembuat kode yang baik, tetapi ini adalah sesuatu yang baik untuk ditingkatkan. Saya tidak berpikir saya akan pernah membuat masalah besar tentang hal seperti ini.

Selama Anda tidak memperlakukannya seperti itu adalah masalah besar, akan mudah untuk menempatkan rekan kerja itu dalam posisi di mana mereka dapat meningkat tanpa menempatkan ego di garis depan.

0
overstood

Golden Rule Berlak

Lakukan kepada orang lain seperti yang Anda inginkan mereka lakukan kepada Anda.

Saya ingin orang lain mendukung hal ini, jadi saya membantu orang lain. Bersikap ramah dan suportif dapat membantu Anda.

0
kevpie

Seperti banyak praktik pemrograman lain yang baik, satu-satunya cara obyektif, non-politik, dan efektif untuk menerapkan kebijakan tentang ejaan dalam program adalah mengotomatiskannya sebagai bagian dari proses pra-komitmen. Otomasi akan menyelamatkan Anda dari sejumlah besar keluhan bahkan jika Anda harus menulis alat sendiri untuk tujuan itu.

0
Apalala

Saya melakukannya hanya jika

  • itu mempengaruhi penggunaan program
  • itu mempengaruhi keakuratan program
  • Secara eksplisit saya tahu penulis ingin dikoreksi.

Sama seperti catatan tambahan, jika nama fungsi Anda cukup panjang untuk memiliki tata bahasa, mereka mungkin terlalu panjang. Dalam contoh yang diberikan, saya akan memanggil fungsi serHasPermission dan memindahkan "tata bahasa" ke dalam kode Anda, sesuatu seperti ini:

if userHasPermission() ...
0
Mark Harrison

Ini juga terjadi BANYAK dalam proyek saya (dihuni oleh orang-orang asli berbahasa Ibrani, Rusia atau Arab), tetapi bahkan ke tingkat yang lebih tinggi - sering saya melihat kode yang menggunakan beberapa terminologi yang tidak jelas yang kebetulan menjadi apa yang dihasilkan kamus sebagai terjemahan untuk apa yang ada dalam pikiran penulis, dan itu tidak ada hubungannya dengan yang mereka maksudkan ...

Secara pribadi, ketika itu terjadi begitu sering dan oleh begitu banyak anggota tim yang bisa menulis kode bahkan sebelum saya bergabung dengan proyek, saya cenderung mengabaikannya, karena itu tidak masalah.

Namun, jika saya melakukan beberapa pekerjaan dalam file yang sama dengan kode atau komentar yang telah ditulis sejak lama dan mereka memiliki kesalahan ketik, saya akan memperbaikinya hanya karena itu tidak terlalu banyak pekerjaan.

0