Saya pikir TODO
komentar, sampai batas tertentu, masuk akal. Terutama jika Anda bekerja iteratif (seperti umum di lincah dan TDD toko), akan ada hal-hal yang Anda mengakui sedang akan diperlukan sebelum panjang tetapi yang Anda tidak ingin membuat jalan memutar untuk melaksanakan saat itu juga.
Yang menjadi jelek adalah ketika komentar seperti itu tetap berada dalam basis kode. Saat Anda secara aktif mengerjakan fitur, tidak masalah untuk membiarkannya masuk, tetapi begitu Anda semakin dekat untuk menyelesaikan fitur, Anda harus fokus untuk menyingkirkannya. Jika Anda tidak ingin melakukan pekerjaan untuk benar-benar menggantinya dengan kode yang benar dan berfungsi, maka, paling tidak faktor fungsionalitas yang relevan. Untuk meminjam contoh @ JoonasPulakka, di mana kode awalnya mengatakan
ConnManager.getConnection("mydatabase"); // FIXME: DB name should be configurable
Anda mungkin mengubahnya menjadi sesuatu seperti
ConnManager.getConnection(GetDatabaseName());
dengan, untuk saat ini, GetDatabaseName () menjadi sebuah rintisan yang hanya mengembalikan string yang sama dengan yang Anda mulai. Dengan begitu, ada titik jelas ekspansi di masa depan, dan Anda tahu bahwa setiap perubahan yang dibuat di sana akan tercermin di mana pun nama database diperlukan. Jika nama database bahkan cukup umum, ini bisa menjadi peningkatan besar dalam pemeliharaan.
Secara pribadi, saya menggunakan kata kunci saya sendiri, bukannya ketat TODO
, meskipun tujuannya sama: untuk menandai hal-hal yang saya tahu perlu ditinjau kembali. Juga, sebelum saya memeriksa kode saya, saya melakukan pencarian kode sumber global untuk kata kunci itu, yang dipilih sedemikian rupa sehingga biasanya tidak akan muncul di mana pun dalam kode. Jika ditemukan, saya tahu saya lupa sesuatu, dan dapat melanjutkan dan memperbaikinya.
Adapun menyertakan nama programmer / tanda tangan dengan komentar, saya pikir itu berlebihan jika Anda memiliki sistem kontrol versi kode sumber (Anda melakukannya , kan?). Dalam hal ini, fitur menyalahkannya akan memberi tahu Anda siapa yang menambahkan komentar, atau lebih tepatnya siapa yang terakhir memeriksa perubahan yang menyentuh komentar. Misalnya, dalam Visual Studio, ini mudah dilakukan dengan menggunakan fitur "Annotate" yang ditemukan di antara fitur kontrol sumber.