I hate your code! (2)

Hari ini saya lihat code yang dibuat oleh orang lain. Coding-nya jelek karena beberapa hal berikut:

• Code yang ditulis tidak konsisten, untuk hal-hal yang mirip dilakukan dengan dengan cara yang berbeda. Biasanya ini terjadi pada programmer yang baru saja belajar dan malas me-refactor code yang sudah ada. Karena tiap kali programmer awal menemuka hal yang bagus, iya akan langsung mengimplementasikannya dan yang sebelumnya dia tinggalkan begitu saja.


• Code generator dibuat untuk mempercepat coding tapi kadang-kadang default template code generator memberikan komentar2 yang menyebalkan (karena tidak perlu). Template untuk code generator sebelum mulai coding harus diubah, pekerjaan sekali tapi kadang tidak dilakukan dan membuat source code kita kotor.


• Komentar pattern. Saya menemukan komentar (javadoc) tentang pattern yang berhubungan dengan suatu class menjadi komentar class tersebut. Tentu saja akan muncul pada dokumentasi api. Ini contoh kontar yang dibuat:

  
  Responsibilities : Bla bla bla
  
  Collaborations   : Bla bla bla
  
  Dependencies     : Bla bla bla
  
  Applied Patterns : Bla bla bla
  
  

  
  Menurut saya ini jelek. Biarkan dokumentasi pattern disimpan di dokumentasi software design. Hal ini karena pattern biasanya melibatkan banyak kelas tidak satu class (pattern Singelton termasuk pattern yang hanya melibatkan satu kelas) jadi pattern tidak berasosiasi kuat dengan satu class. Saya tidak tau dari mana dia mendapat ide untuk membuat komentar seperti itu. Ada yang pernah membuat komentar seperti itu?