Saya benci referensi konten paywalled, tapi video ini menunjukkan apa yang saya bicarakan. Tepatnya 12 menit dalam Robert Martin melihat ini:

Dan mengatakan "Salah satu hal favorit saya untuk dilakukan adalah menyingkirkan kawat gigi yang tidak berguna" saat dia mengubahnya menjadi ini:

Dahulu kala, dalam pendidikan yang sangat jauh, saya diajari untuk tidak melakukan ini karena membuatnya mudah untuk memperkenalkan bug dengan menambahkan garis indentasi lain yang berpikir itu dikendalikan oleh ifsaat tidak.

Agar adil bagi Paman Bob, ia merecode metode Java yang panjang hingga fungsi kecil yang, saya setuju, jauh lebih mudah dibaca. Ketika dia selesai mengubahnya, (22.18) terlihat seperti ini:

Saya bertanya-tanya apakah itu seharusnya memvalidasi menghapus kawat gigi. Saya sudah terbiasa dengan praktik terbaik . Bisakah Paman Bob ditantang dalam hal ini? Apakah Paman Bob membela gagasan itu?

Keterbacaan bukanlah hal kecil.

Saya memiliki pikiran campuran ketika datang ke kawat gigi yang melampirkan metode tunggal. Saya pribadi menghapusnya untuk hal-hal seperti pernyataan pengembalian satu baris, tetapi meninggalkan kawat gigi seperti itu sebenarnya sangat menggigit kami di tempat terakhir saya bekerja. Seseorang menambahkan satu baris kode ke ifpernyataan tanpa juga menambahkan tanda kurung yang diperlukan, dan karena itu adalah C, itu menabrak sistem tanpa peringatan.

Saya tidak pernah menantang siapa pun yang religius tentang selalu menggunakan kawat gigi setelah kegagalan kecil itu.

Jadi saya melihat manfaat dari keterbacaan, tetapi saya sangat menyadari masalah yang dapat muncul ketika Anda meninggalkan kawat gigi itu.

Saya tidak akan repot mencari studi atau pendapat seseorang yang dipublikasikan. Setiap orang memiliki satu (pendapat, yaitu), dan karena ini adalah masalah gaya, satu pendapat sama baiknya dengan yang lain. Pikirkan masalah Anda sendiri, evaluasi pro dan kontra, dan buat pikiran terkutuk Anda sendiri. Jika toko tempat Anda bekerja memiliki standar pengkodean yang mencakup masalah ini, cukup ikuti itu.

Anda dapat menemukan beberapa promosi yang diterbitkan atau penolakan gaya tanpa penyangga di sini atau di sini atau di mana gudang sepeda dicat.

Melangkah menjauh dari gudang sepeda, ingat bug OS X / iOS SSL hebat tahun 2014?

if ((err = SSLHashSHA1.update(&hashCtx, &serverRandom)) != 0)
    goto fail;
if ((err = SSLHashSHA1.update(&hashCtx, &signedParams)) != 0)
    goto fail;
    goto fail;
if ((err = SSLHashSHA1.final(&hashCtx, &hashOut)) != 0)
    goto fail;

Yap, "disebabkan" oleh blok tanpa penyangga https://www.imperialviolet.org/2014/02/22/applebug.html

Preferensi mungkin tergantung pada gaya penyangga. Jika saya harus menulis

if (suiteSetup)
{
    includePage(mode, suiteSetup);
}

Saya mungkin cenderung menghemat ruang juga. Tapi

if (suiteSetup) {
    includePage(mode, suiteSetup);
}

hanya menggunakan satu baris "ekstra".

Saya tahu Anda tidak bertanya, tetapi jika saya bekerja sendiri, saya adalah bidat. Jika saya menghapus kawat gigi, saya lebih suka

if (suiteSetup != null) includePage(mode, suiteSetup);

Ini tidak memiliki masalah visual yang sama dengan bug iOS-style iOS, tetapi menyimpan lebih banyak baris "tidak perlu" daripada Paman Bob;) Dibaca dengan baik jika Anda terbiasa, dan memiliki penggunaan umum di Ruby ( includePage(mode, suiteSetup) unless suiteSetup.nil?). Oh well, ketahuilah bahwa ada banyak pendapat.

Paman Bob memiliki banyak lapisan pertahanan terhadap kesalahan seperti itu yang tidak biasa ketika "selalu menggunakan kawat gigi" adalah kebijaksanaan yang berlaku:

1. Preferensi pribadi yang kuat untuk persyaratan jalur tunggal, sehingga yang multi-jalur menonjol dan menerima pengawasan ekstra.
2. Editor yang secara otomatis ketinggalan zaman ketika Anda memasukkan baris kedua.
3. Rangkaian lengkap unit test yang ia jalankan secara konstan.
4. Serangkaian tes integrasi lengkap.
5. Tinjauan sejawat dilakukan sebelum kodenya digabungkan.
6. Jalankan kembali semua tes dengan server integrasi berkelanjutan.
7. Pengujian dilakukan oleh departemen kualitas produk.

Saya pikir jika seseorang menerbitkan tantangan kepada Paman Bob, ia akan memiliki bantahan yang cukup bagus dengan poin-poin di atas. Ini adalah salah satu kesalahan termudah untuk ditangkap lebih awal.

Untuk sebagian besar ini adalah preferensi pribadi, namun ada beberapa hal yang perlu dipertimbangkan.

Kemungkinan Bug

Meskipun dapat dikatakan bahwa bug yang disebabkan oleh lupa untuk menambahkan-in kawat gigi jarang terjadi, dari apa yang saya lihat bahwa mereka tidak terjadi sesekali (tidak melupakan terkenal goto IOS gagal bug). Jadi saya pikir ini harus menjadi faktor ketika mempertimbangkan gaya kode Anda (beberapa alat memperingatkan tentang indentasi menyesatkan , jadi itu tergantung pada rantai alat Anda juga) .

Hari Code (yang berbunyi seperti itu mungkin menjadi bug)

Bahkan dengan asumsi proyek Anda tidak menderita dari bug tersebut, ketika membaca kode Anda mungkin melihat beberapa blok dari kode yang terlihat seperti mereka bisa menjadi bug - tetapi tidak, mengambil beberapa siklus mental Anda.

Kita mulai dengan:

if (foo)
    bar();

Pengembang menambahkan komentar yang bermanfaat.

if (foo)
    // At this point we know foo is valid.
    bar();

Kemudian pengembang mengembangkannya.

if (foo)
    // At this point we know foo is valid.
    // This never fails but is too slow even for debug, so keep disabled.
    // assert(is_valid(foo));
    bar();

Atau menambahkan blok bersarang:

if (foo)
    while (i--) {
        bar(i);
        baz(i);
    }

Atau menggunakan makro:

if (foo)
    SOME_MACRO();

"... Karena makro dapat mendefinisikan beberapa baris kode, apakah makro digunakan do {...} while (0)untuk banyak baris? Seharusnya karena itu ada dalam panduan gaya kita tapi aku lebih baik memeriksa kalau-kalau!"

Contoh di atas adalah semua kode yang valid, namun semakin banyak konten dalam blok-kode, semakin banyak yang perlu Anda baca untuk memastikan tidak ada kesalahan.

Mungkin gaya kode Anda mendefinisikan bahwa blok multi-line memerlukan penjepit (tidak peduli apa, bahkan jika itu bukan kode) , tetapi saya telah melihat komentar semacam ini ditambahkan dalam kode produksi. Ketika Anda membacanya, ada sedikit keraguan bahwa siapa pun yang terakhir mengedit baris-baris itu lupa menambahkan kurung kurawal, kadang-kadang saya merasa perlu memeriksa ulang berfungsi sebagaimana dimaksud (terutama ketika menyelidiki bug di area kode ini) .

Kebisingan Diff

Salah satu alasan praktis untuk menggunakan kawat gigi untuk saluran tunggal adalah untuk mengurangi kebisingan berbeda .

Yaitu, mengubah:

if (foo)
    bar();

Untuk:

if (foo) {
    bar();
    baz();
}

... menyebabkan garis kondisional muncul di dalam diff ketika sedang diubah, ini menambahkan beberapa overhead kecil tetapi tidak perlu.

• baris muncul sebagai sedang diubah dalam tinjauan kode, jika alat Anda berbeda berbasis kata Anda dapat dengan mudah melihat bahwa hanya kurung kurawal yang berubah, tetapi itu membutuhkan lebih banyak waktu untuk memeriksa lalu jika garis tidak berubah sama sekali.
  Karena itu, tidak semua alat mendukung perbedaan berbasis kata, diff (svn, git, hg ... dll) akan menunjukkan seolah-olah seluruh baris berubah, bahkan dengan alat mewah, kadang-kadang Anda mungkin perlu dengan cepat melihat ke garis polos berbasis-diff untuk melihat apa yang berubah.
• alat anotasi (seperti git blame) akan menunjukkan baris sebagai sedang diubah, membuat pelacakan asal dari suatu langkah lebih banyak untuk menemukan perubahan nyata .

Keduanya kecil, dan tergantung pada berapa banyak waktu yang Anda habiskan dalam tinjauan kode atau pelacakan yang melakukan perubahan baris kode.

Ketidaknyamanan yang lebih nyata karena perubahan garis tambahan dalam diff, kemungkinan kapalnya lebih tinggi bahwa perubahan dalam kode akan menyebabkan konflik yang menggabungkan dan perlu diselesaikan secara manual .

Ada pengecualian untuk ini, untuk basis kode yang memiliki {jalurnya sendiri - ini bukan masalah.

The diff kebisingan argumen tidak tahan jika Anda menulis dalam gaya ini:

if (foo)
{
    bar();
    baz();
}

Namun ini bukan konvensi umum, jadi terutama menambahkan jawaban untuk kelengkapan (tidak menyarankan proyek harus menggunakan gaya ini) .

Bertahun-tahun yang lalu, saya dibawa untuk men-debug beberapa kode C. Bug itu sangat sulit ditemukan, tetapi akhirnya ia berubah menjadi pernyataan seperti:

if (debug)
   foo (4);

Dan ternyata orang yang menulisnya telah didefinisikan foosebagai makro. Makro dengan dua baris kode di dalamnya. Dan tentu saja, hanya yang pertama dari dua baris yang dikenakan if. (Jadi baris kedua dieksekusi tanpa syarat.)

Ini mungkin benar-benar unik untuk C dan preprosesornya - yang melakukan pergantian sebelum kompilasi - tetapi saya tidak pernah melupakannya. Hal semacam itu meninggalkan bekas pada Anda, dan mengapa tidak bermain aman - terutama jika Anda menggunakan berbagai bahasa dan perkakas dan tidak dapat memastikan bahwa kejahatan seperti itu tidak mungkin terjadi di tempat lain?

Sekarang saya inden dan menggunakan kawat gigi secara berbeda dari orang lain, tampaknya. Untuk satu baris if, saya akan lakukan:

if (debug) { foo (4); }

jadi tidak perlu jalur tambahan untuk memasukkan kawat gigi.

"Paman Bob" diizinkan untuk memiliki pendapatnya, Anda diizinkan untuk memiliki pendapat Anda. Tidak perlu menantangnya.

Jika Anda ingin banding ke pihak berwenang, ambil Chris Lattner. Di Swift, jika pernyataan kehilangan tanda kurung, tetapi selalu disertai dengan tanda kurung. Tidak ada diskusi, itu bagian dari bahasa. Jadi jika "Paman Bob" mulai menghapus kawat gigi, kode berhenti mengkompilasi.

Memeriksa kode orang lain dan "menyingkirkan kawat gigi yang tidak berguna" adalah kebiasaan buruk. Hanya menyebabkan kerja ekstra ketika kode perlu ditinjau, dan ketika konflik tidak perlu dibuat. Mungkin "Paman Bob" adalah programmer yang sangat baik sehingga dia tidak perlu ulasan kode? Saya menyia-nyiakan satu minggu dalam hidup saya karena seorang programmer terkemuka mengubah "if (p! = NULL)" menjadi "if (! P)" tanpa ulasan kode, disembunyikan di tempat yang paling buruk.

Ini sebagian besar merupakan perdebatan gaya yang tidak berbahaya. Kawat gigi memiliki keuntungan bahwa Anda dapat menyisipkan baris kode lain tanpa menambahkan kawat gigi. Seperti pernyataan logging, atau komentar (jika diikuti oleh komentar diikuti oleh pernyataan hanya mengerikan). pernyataan pada baris yang sama seolah-olah memiliki kelemahan praktis bahwa Anda memiliki masalah dengan banyak debuggers. Tetapi lakukan apa yang Anda inginkan.

Alasan saya untuk tidak melepas kawat gigi adalah:

1. mengurangi keputusasaan keputusan. Jika Anda selalu menggunakan kawat gigi, Anda tidak perlu memutuskan apakah Anda akan membutuhkan kawat gigi atau tidak.

2. mengurangi hambatan pengembangan: bahkan jika Anda berusaha untuk akhirnya mengekstrak semua baris logika untuk metode, harus mengkonversi gelang jika untuk menguatkan jika untuk menambah logika adalah sedikit hambatan pembangunan yang mengganggu. Jadi ada upaya menghapus kawat gigi, dan upaya menambahkannya lagi ketika Anda membutuhkan lebih banyak kode. Mungil, tapi menyebalkan.

Seorang rekan kerja muda mengatakan bahwa kawat gigi yang kita lihat mubazir dan tidak berguna sebenarnya berguna baginya. Saya tidak ingat persis mengapa, tetapi jika memungkinkan dia untuk menulis kode yang lebih baik lebih cepat, itu saja alasan untuk mempertahankannya.

Fwiw, kami sepakat pada kompromi yang menempatkan mereka pada satu baris tidak membuat prasyarat singkat seperti itu tidak dapat dibaca / mengganggu saya. Misalnya

if (!param) { throw invalid_argument (blahblah); }
if (n < 2) { return 0; }
// real code for function starts here...

Saya juga menunjukkan bahwa prasyarat pengantar ini sering merupakan pernyataan aliran kontrol untuk tubuh (misalnya a return) sehingga rasa takut untuk menambahkan pernyataan kedua yang dimaksudkan berada di bawah kondisi yang sama dan lupa untuk menulis kawat gigi sedang diperdebatkan. Pernyataan kedua dalam kondisi ini akan menjadi kode mati dan tidak masuk akal.

Saya menduga bahwa kelancaran dalam masalah membaca disebabkan oleh parser otak seseorang yang ditransfer untuk memiliki kawat gigi sebagai bagian dari pernyataan kondisional. Itu bukan representasi akurat dari tata bahasa C ++, tetapi bisa menjadi efek samping dari belajar bahasa lain tertentu terlebih dahulu, di mana itu terjadi.

Setelah menonton video itu sekarang, saya perhatikan bahwa menghilangkan kawat gigi membuatnya lebih mudah untuk melihat di mana kode masih perlu di refactored. Jika Anda membutuhkan kawat gigi, kode Anda mungkin bisa sedikit lebih bersih.

Karena itu, ketika Anda berada di tim, menghilangkan kawat gigi mungkin akan menyebabkan perilaku yang tidak terduga suatu hari nanti. Saya katakan menjaga mereka, dan Anda akan menyelamatkan diri Anda dari banyak sakit kepala ketika terjadi kesalahan.

Saya diajari untuk tidak melakukan ini karena membuatnya mudah untuk memperkenalkan bug dengan menambahkan garis indentasi lain yang berpikir bahwa itu dikendalikan oleh if ketika tidak.

Jika kode Anda diuji unit dengan baik , "bug" semacam ini akan meledak di wajah.

Membersihkan kode dengan menghindari tanda kurung yang tidak berguna dan jelek adalah praktik yang saya ikuti.