Itu harus dengan lembut dicegah
..you tidak mungkin tahu siapa yang akan melihat kode sumber selama masa pakainya.
Walaupun itu semua adalah bagian dari pekerjaan untuk frustrasi dengan potongan kode yang sangat kompleks atau lama dan ingin mengabaikannya, memasukkan kata-kata kasar / kata kasar / seni ASCII / lelucon buruk / komentar ofensif ke dalam kode sumber keduanya tidak profesional dan ide buruk dalam pengalaman saya. Terkadang, insinyur yang menulis komentar tidak menyadari efek akhirnya dari komentarnya - berikut adalah beberapa masalah yang saya lihat:
- Sejumlah besar sumpah serapah dalam kode dirilis ke publik sebagai kode sumber terbuka / sampel.
- Lelucon dalam rasa yang buruk menyebabkan pelanggaran mendalam bagi beberapa anggota tim yang menghasilkan pengadilan industri.
- Komentar yang dibuang yang sebenarnya rasis / seksis / gender menyebabkan orang dipecat.
Sementara kita semua perlu memiliki beberapa outlet untuk frustrasi / bersenang-senang / japing tentang, kode sumber bukan tempat untuk melakukan ini, IMO. Anda tidak akan memasukkan komentar kasar / lelucon / komentar ofensif dalam Kontrak, Halaman Bantuan, Cetak Biru, atau dokumen profesional lainnya, meskipun dokumen-dokumen itu mungkin lebih jarang dibaca daripada kode sumber.
Jika para pemimpin tim mendapatkan semua tentang hal itu, akan ada kesal, jadi saya katakan 'lemah hati' dengan kata-kata yang tenang dengan insinyur yang bermasalah dan menyediakan mekanisme ventilasi yang sesuai untuk mengeluarkan uap, apakah itu Facebook, pesan instan , hoki udara atau karung tinju.
Tidak ada pembelaan untuk mengatakan bahwa komentar dikompilasi baik - bagaimana dengan JavaScript, atau kode sisi klien dinamis lainnya?
Berikut adalah beberapa pengalaman dunia nyata yang saya miliki yang membentuk pendapat saya:
Saat bekerja di Microsoft, saya melihat bahwa seorang insinyur perangkat lunak tidak tahu ejaan yang benar dari "tidak bisa" - dia merindukan o, l dan d - dan telah membumbui banyak kode dengan penjelasan panjang tentang bagaimana dia tidak bisa dapatkan X untuk bekerja karena orang Y yang menyebabkan masalah Z. Kode-nya hebat; ejaannya tidak begitu baik. Cukuplah untuk mengatakan, setiap peninjau kode ini selanjutnya (misalnya saya) khawatir untuk melihat sejumlah besar sumpah acak dalam kode. Beberapa kode ini selanjutnya ditampilkan kepada mitra (penulis driver). Bayangkan ketakutan mereka melihat sumpah serapah. Kata-kata kasar idealnya harus kepada manajer proyek dalam bentuk verbal (dalam hal ini orang Y dapat ditarik ke diskusi) atau mungkin melakukan pesan, tetapi tidak dalam sumber.
Di satu perusahaan, seorang individu yang berbahasa asing bergabung dengan tim yang sebagian besar berbahasa Inggris. Dia menulis komentar dalam bahasanya, berpikir bahwa tidak ada orang lain yang bisa membacanya. Ini baik-baik saja, sampai Babelfish / Google Translate merilis opsi 'ke bahasa Inggris' untuk bahasanya, di mana saat itu seluruh anggota tim menerjemahkan beberapa komentar dan terkejut dengan komentar-komentar yang kotor dan sering menghina yang telah dibuat orang itu tentang perusahaan tersebut. , timnya dan seorang rekan kerja wanita. Canggung .
Di perusahaan lain, seorang lelaki benar-benar tertarik dengan seni ASCII dan memasukkan segala macam karya seni ke dalam kode sumbernya, tidak ternoda (atau mungkin diberkati) oleh peninjau kode. Setelah beberapa saat, dia memikirkan naga, untuk beberapa alasan, biasanya dengan semacam tag line. Kemudian, seorang Welsh bergabung dengan tim. Lambang nasional Wales adalah naga merah, jadi lelaki baru itu awalnya senang dengan gambar-gambar itu, tetapi kemudian tersinggung ketika beberapa garis tag konyol bisa dianggap sebagai ofensif. Ya, beberapa mediasi pemimpin tim diperlukan, tetapi ini seharusnya tidak terjadi.
Nama / spesifik dihapus untuk melindungi yang tidak bersalah.