Що мається на увазі під назвою "TODO Автоматично створений заглушок методу"? [зачинено]

9

Я використовую eclipse для програмування Android, і тут і там я бачу вислів "TODO Автоматично створений метод заглушки".

Я розумію, що ці методи генерувалися автоматично затемненням при створенні класів та інших тригерних заходах, але я не розумію необхідності того, щоб це було згадано всюди.

Про що потрібно згадувати це скрізь неодноразово?

android coding-standards eclipse

1

ви можете змінити шаблон у Eclipse, якщо він вам не сподобається

— DPM

3

Це питання, здається, поза темою, оскільки не демонструє мінімального розуміння IDE, що використовується.

— Джим Г.

9

TODO - це одне з кількох ключових слів за замовчуванням, які вказують на завдання, які потрібно виконати в Eclipse. Під вікнами-> Налаштування-> Java-> Компілятор-> Теги завдань, ви повинні побачити ці ключові слова. Вважається, що слід додати коментар до цього ключового слова, щоб автоматично вказати речі, які ще потрібно виконати, що зручно, якщо ви використовуєте ці теги завдань.

Однак якщо ви їх не використовуєте, вам слід змінити шаблони коду (Налаштування-> Java-> Стиль коду-> Шаблони коду) для усунення цих коментарів.

Зокрема:

Код-> Орган методу
Код-> Корпус конструктора
Код-> Тіло лову блоку

— Ніл
джерело

5

Це не просто Eclipse, який підтримує коментарі TODO - NetBeans, Visual Studio, JetBrains тощо, а також надає функціональний список списку завдань, який витягується з коментарів у стилі TODO. Крім того, це не відповідає на поставлене запитання - що означає коментар у стилі TODO та наскільки він цінний.

— Томас Оуенс

2

Я віддаю перевагу поведінці Visual Studio (ReSharpers?) По створенню заглушок, які, throw new NotImplementedException();оскільки вони набагато важче ігнорувати, ніж беззвучно невдалий порожній метод.

— Dan Dan Fiddling Firelight

1

@ThomasOwens Він назвав eclipse, а не NetBeans, Visual Studio, JetBrains та ін. Крім того, це саме те, що означає TODO і як він використовується.

— Ніл

1

@DanNeely Мені це теж подобається, тому мої автоматично створені кодові шаблони в Eclipse виглядають так:throw new UnsupportedOperationException("Auto-generated method stub"); // TODO Auto-generated method stub

— Simon Lehmann

16

Eclipse створює просто порожні методи, які повертають null (звідси "заглушка"). Коментарі вставляються, щоб нагадати розробнику, що він, ймовірно, захоче щось зробити в цих методах, інакше навіщо вони існувати? Ви повинні видалити коментарі, коли це зробите.

Якщо ви бачите ці коментарі повсюдно, то або (якщо насправді містять реалізацію), розробники ледачі, або вважають, що коментарі мають якусь іншу мету, тому не видаляйте їх, або це вказівка на слабкий дизайн, як правило, інтерфейси, які занадто великі і мають реалізацію (і користувачів), які насправді не використовують усі методи в інтерфейсі.

— Майкл Боргвардт
джерело

7

Багато IDE, включаючи Eclipse, використовують "TODO" в коментарі для створення списків завдань. Ці списки завдань включають текст коментаря та файл та метод, до якого коментується. Це дозволяє всім, хто використовує інструмент із цією функціональністю, генерувати списки речей, які ще відкриті. Існують також деякі інші загальні ідентифікатори, наприклад FIXME або XXX, які мають подібний функціонал у деяких IDE. Це запитання на сторінці переповнення стека запитує про ключові слова коментарів у Eclipse та надає додаткову інформацію.

Коли ви автоматично генеруєте деякі функції, очікується, що ви будете вставляти власну реалізацію. Він додає відповідну заглушку, щоб ваш код збирався, але додає коментарі, щоб можна було швидко знайти методи, які потрібно реалізувати. Зауважте, що деякі автогенеровані функції, як-от автогенерація toStringта hashcodeфункції, не містять цих коментарів, оскільки не очікується, що ви їх модифікуєте.

Існують способи відключити вставлення цих даних, редагуючи шаблони, які використовуються для створення автогенерованого коду, якщо це вас сильно турбує. Однак вони корисні. Простий пошук у вашій кодовій базі таких речей, як TODO та FIXME, може стати основою списку завдань, якщо вони поєднуються з гідним коментарем щодо того, що потрібно зробити, особливо для менших проектів.

— Томас Оуенс
джерело

4

TODO просто означає "НАД", генерується заглушка, але розробнику або програмісту потрібно додати код за потребою.

— user42588
джерело