Многие IDE, в том числе Eclipse, используют «TODO» в комментарии для создания списков задач. Эти списки задач включают текст комментария, а также файл и метод, в котором находится комментарий. Это позволяет каждому, кто использует инструмент с этой функциональностью, создавать списки вещей, которые все еще открыты. Есть также некоторые другие общие идентификаторы, такие как FIXME или XXX, которые имеют похожую функциональность в некоторых IDE. Этот вопрос о переполнении стека задает вопрос о ключевых словах комментариев в Eclipse и предоставляет дополнительную информацию.
Когда вы автоматически генерируете некоторые функции, ожидается, что вы вставите свою собственную реализацию. Он добавляет соответствующую заглушку, чтобы ваш код компилировался, но добавляет комментарии, чтобы вы могли быстро найти методы, которые необходимо реализовать. Обратите внимание, что некоторые автоматически сгенерированные функции, такие как autogenerated toString
и hashcode
functions, не содержат этих комментариев, потому что вы не будете изменять их.
Есть способы отключить их вставку, отредактировав шаблоны, используемые для создания автоматически сгенерированного кода, если это вас сильно беспокоит. Однако они полезны. Простой поиск в вашей кодовой базе таких вещей, как TODO и FIXME, может стать основой списка задач, если они сочетаются с достойным комментарием о том, что необходимо сделать, особенно в небольших проектах.