Apa yang dimaksud dengan, “rintisan metode yang dihasilkan secara otomatis TODO”? [Tutup]

9

Saya menggunakan eclipse untuk pemrograman android, dan setiap di sana-sini saya melihat pernyataan, "TODO Auto-generate method stub."

Saya mengerti bahwa metode ini dihasilkan secara otomatis oleh gerhana pada penciptaan kelas dan kegiatan pemicu lainnya, tetapi saya tidak mengerti perlunya disebutkan di mana-mana.

Apa perlunya disebutkan berulang kali di mana-mana?

android coding-standards eclipse
sumber
1
Anda dapat mengubah templat di Eclipse jika Anda tidak menyukainya
DPM
3
Pertanyaan ini tampaknya di luar topik karena tidak menunjukkan pemahaman minimal tentang IDE yang digunakan.
Jim G.

Jawaban:

9

TODO adalah salah satu dari beberapa kata kunci default yang menunjukkan tugas untuk dilakukan di Eclipse. Di bawah windows-> Preferences-> Java-> Compiler-> Tag Tugas, Anda akan melihat kata kunci ini. Diperkirakan menambahkan komentar dengan kata kunci ini untuk secara otomatis menunjukkan hal-hal yang masih harus diselesaikan, yang nyaman jika Anda menggunakan tag tugas ini.

Namun, jika Anda tidak menggunakannya, Anda harus memodifikasi templat kode (Preferensi-> Java-> Kode Gaya-> Templat Kode) untuk menghilangkan komentar ini.

Khususnya:

  • Kode-> Metode badan
  • Kode-> Badan pembuat
  • Kode-> Tangkap blok tubuh
Neil
sumber
5
Ini lebih dari sekadar Eclipse yang mendukung komentar TODO - NetBeans, Visual Studio, JetBrains, dan lainnya juga menyediakan fungsionalitas daftar tugas yang diekstrak dari komentar gaya TODO. Selain itu, ini tidak menjawab pertanyaan yang diajukan - apa arti gaya komentar TODO dan bagaimana nilainya.
Thomas Owens
2
Saya lebih suka perilaku Visual Studio (ReSharpers?) Menghasilkan bertopik yang throw new NotImplementedException();karena mereka jauh lebih sulit untuk diabaikan oleh obliviot daripada metode kosong gagal diam-diam.
Dan Is Fiddling By Firelight
1
@ThomasOwens Dia menamai gerhana, bukan NetBeans, Visual Studio, JetBrains, dan lainnya. Selain itu, inilah tepatnya yang dimaksud dengan TODO dan cara penggunaannya.
Neil
1
@DanNeely saya suka ini juga, itu sebabnya templat kode yang saya buat otomatis di Eclipse terlihat seperti ini:throw new UnsupportedOperationException("Auto-generated method stub"); // TODO Auto-generated method stub
Simon Lehmann
16

Eclipse menciptakan metode kosong yang mengembalikan null (karenanya "rintisan"). Komentar dimasukkan untuk mengingatkan pengembang bahwa ia mungkin ingin melakukan sesuatu dalam metode itu, kalau tidak mengapa harus ada? Anda seharusnya menghapus komentar ketika Anda melakukannya.

Jika Anda melihat komentar itu di semua tempat, maka (jika sebenarnya mengandung implementasi) pengembang malas atau percaya komentar memiliki tujuan lain dan karena itu tidak menghapusnya, atau itu merupakan indikasi dari desain yang lemah, biasanya antarmuka yang terlalu besar dan memiliki implementasi (dan pengguna) yang tidak benar-benar menggunakan semua metode di antarmuka.

Michael Borgwardt
sumber
7

Banyak IDE, termasuk Eclipse, menggunakan "TODO" dalam komentar untuk menghasilkan daftar tugas. Daftar tugas ini termasuk teks komentar dan file serta metode yang digunakan komentar. Ini memungkinkan setiap orang menggunakan alat dengan fungsi ini menghasilkan daftar hal-hal yang masih terbuka. Ada juga beberapa pengidentifikasi umum lainnya, seperti FIXME atau XXX yang memiliki fungsi serupa di beberapa IDE. Ini pertanyaan pada Stack Overflow bertanya tentang kata kunci komentar di Eclipse , dan memberikan beberapa informasi tambahan.

Saat Anda membuat beberapa fungsi secara otomatis, diharapkan Anda akan memasukkan implementasi Anda sendiri. Itu menambahkan rintisan yang sesuai sehingga kode Anda akan dikompilasi, tetapi menambahkan komentar sehingga Anda dapat dengan cepat menemukan metode yang perlu diterapkan. Perhatikan bahwa beberapa fungsi yang dibuat secara otomatis, seperti yang dibuat secara otomatis toStringdan hashcodefungsi tidak mengandung komentar ini karena tidak diharapkan Anda akan memodifikasinya.

Ada beberapa cara untuk menonaktifkan penyisipan ini dengan mengedit templat yang digunakan untuk membuat kode yang dibuat secara otomatis, jika itu mengganggu Anda. Namun, mereka bermanfaat. Cukup mencari basis kode Anda untuk hal-hal seperti TODO dan FIXME dapat menjadi dasar dari daftar tugas jika ditambah dengan komentar yang layak tentang apa yang perlu dilakukan, terutama pada proyek yang lebih kecil.

Thomas Owens
sumber
4

TODO berarti "TO DO", rintisan dihasilkan tetapi pengembang atau pemrogram perlu menambahkan kode sesuai kebutuhan.

pengguna42588
sumber