Co należy rozumieć przez „skrót metody TODO generowany automatycznie”? [Zamknięte]

9

Korzystam z Eclipse do programowania na Androida, a tu i tam widzę oświadczenie „TODO Metoda generowana automatycznie”.

Rozumiem, że metody te zostały wygenerowane automatycznie przez zaćmienie po utworzeniu klas i innych działań wyzwalających, ale nie rozumiem potrzeby, aby wszędzie o tym wspominać.

O czym trzeba powtarzać to wszędzie?

android coding-standards eclipse
źródło
1
możesz zmienić szablon w Eclipse, jeśli ci się nie podoba
DPM
3
To pytanie wydaje się nie na temat, ponieważ nie pokazuje minimalnego zrozumienia używanego IDE.
Jim G.

Odpowiedzi:

9

TODO jest jednym z kilku domyślnych słów kluczowych, które wskazują zadania do wykonania w środowisku Eclipse. W obszarze windows-> Preferencje-> Java-> Kompilator-> Tagi zadań powinieneś zobaczyć te słowa kluczowe. Uważa się, że należy dodać komentarz do tego słowa kluczowego, aby automatycznie wskazać rzeczy do ukończenia, co jest wygodne, jeśli użyjesz tych tagów zadań.

Jeśli jednak ich nie użyjesz, zmodyfikuj szablony kodu (Preferencje-> Java-> Styl kodu-> Szablony kodu), aby wyeliminować te komentarze.

W szczególności:

  • Kod-> Treść metody
  • Kod-> Korpus konstruktora
  • Kod-> Ciało bloku chwytającego
Neil
źródło
5
To coś więcej niż tylko Eclipse, który obsługuje komentarze do ZROBIENIA - NetBeans, Visual Studio, JetBrains, a także zapewnia funkcje listy zadań, które wyodrębniają z komentarzy w stylu TODO. Ponadto nie odpowiada to na zadane pytanie - co oznacza komentarz w stylu TODO i jak ma wartość.
Thomas Owens
2
Wolę zachowanie Visual Studio (ReSharpers?) Generowania throw new NotImplementedException();kodów pośredniczących, które są o wiele trudniejsze do zignorowania przez obliviota niż cicha metoda pusta.
Dan Is Fiddling By Firelight
1
@ThomasOwens Nazwał eclipse, a nie NetBeans, Visual Studio, JetBrains i inne. Ponadto dokładnie to oznacza TODO i sposób jego użycia.
Neil
1
@DanNeely też to lubię, dlatego moje automatycznie generowane szablony kodu w Eclipse wyglądają tak:throw new UnsupportedOperationException("Auto-generated method stub"); // TODO Auto-generated method stub
Simon Lehmann
16

Zaćmienie tworzy tylko puste metody, które zwracają null (stąd „stub”). Komentarze zostały wstawione, aby przypomnieć programistom, że prawdopodobnie będzie chciał zrobić coś z tymi metodami, w przeciwnym razie dlaczego powinny istnieć? Powinieneś usunąć komentarze, gdy to zrobisz.

Jeśli widzisz te komentarze w dowolnym miejscu, to albo (jeśli faktycznie zawierają implementacje) programiści są leniwi lub uważają, że komentarze mają jakiś inny cel i dlatego nie usuwają ich, lub jest to oznaka słabego projektu, zwykle interfejsy, które są zbyt duże i mają implementacje (i użytkowników), które w rzeczywistości nie używają wszystkich metod interfejsu.

Michael Borgwardt
źródło
7

Wiele IDE, w tym Eclipse, używa „TODO” w komentarzu do generowania list zadań. Te listy zadań zawierają tekst komentarza oraz plik i metodę, w której znajduje się komentarz. Dzięki temu wszyscy korzystający z narzędzia z tą funkcją mogą generować listy rzeczy, które są nadal otwarte. Istnieją również inne popularne identyfikatory, takie jak FIXME lub XXX, które mają podobną funkcjonalność w niektórych IDE. To pytanie dotyczące przepełnienia stosu dotyczy słów kluczowych związanych z komentarzami w środowisku Eclipse i zawiera dodatkowe informacje.

Podczas automatycznego generowania niektórych funkcji należy się spodziewać, że wstawisz własną implementację. Dodaje odpowiedni kod pośredniczący, aby kod się skompilował, ale dodaje komentarze, dzięki czemu można szybko znaleźć metody, które należy zaimplementować. Pamiętaj, że niektóre funkcje generowane automatycznie, takie jak funkcje generowane automatycznie toStringi hashcodefunkcje nie zawierają tych komentarzy, ponieważ nie oczekuje się, że je zmodyfikujesz.

Istnieją sposoby, aby wyłączyć wstawianie tych plików, edytując szablony używane do tworzenia kodu generowanego automatycznie, jeśli tak bardzo Ci to przeszkadza. Są jednak przydatne. Po prostu przeszukiwanie bazy kodu w poszukiwaniu takich rzeczy jak TODO i FIXME może być podstawą listy zadań, jeśli są one połączone z porządnym komentarzem na temat tego, co należy zrobić, szczególnie w przypadku mniejszych projektów.

Thomas Owens
źródło
4

TODO oznacza po prostu „DO ZROBIENIA”, kod pośredniczący jest generowany, ale programista lub programista musi w razie potrzeby dodać kod.

użytkownik42588
źródło