Saya ingin bertanya kepada Anda apakah menambahkan beberapa "telur paskah" dalam dokumentasi sumber tidak profesional atau tidak. Mungkin Anda memiliki membaca StackOverflow jajak pendapat untuk komentar lucu dalam sumber dokumentasi, dan saya secara pribadi telah tersandung di banyak hal-hal seperti selama saya bekerja, termasuk lucu (atau tidak) hal-hal dalam dokumentasi API publik (misalnya lemah ini BZZZTT !! 1! Hal dalam dokumentasi publik Android, saya dapat memberikan setidaknya selusin contoh lagi).
Saya tidak bisa sampai pada pendapat akhir untuk diri saya sendiri, karena saya sendiri memiliki argumen yang bertentangan.
Argumen pro:
- Itu bisa menghibur seseorang, dan membuat harinya lebih lucu / lebih produktif. Sebagian besar kode sumber tidak perlu dikomentari pula (jika proyek dilakukan dengan benar), karena metode spesifik (misalnya) cukup jelas, atau jika itu adalah tumpukan kode jelek yang aneh, ia tidak bisa dijelaskan dengan cara yang bermakna, sehingga lelucon lucu tidak membahayakan info yang mungkin bisa Anda peroleh dari dokter.
Argumen kontra:
- Jika Anda sangat terkonsentrasi / frustrasi, hal terakhir yang Anda butuhkan adalah lelucon bodoh seseorang, alih-alih memberi Anda informasi yang Anda butuhkan tentang bagian kode yang terdokumentasi, itu hanya dapat membuat Anda semakin frustrasi. Dan gagasan tentang bagaimana dokumentasi akan terlihat jika semua orang mulai melakukannya adalah mengerikan. Ditambah lagi lelaki yang menulis lelucon mungkin satu-satunya yang berpikir bahwa itu lucu / menarik / layak buang waktu untuk membacanya.
Apa yang kamu pikirkan?