Многострочный TODO: комментарии в Eclipse

Довольно прямой вопрос здесь. Кто-нибудь понял, как сделать TODO: комментарий в Eclipse, который занимает несколько строк? Я не могу на всю жизнь заставить его работать.


person Will Madison    schedule 16.06.2011    source источник
comment
Хм, я бы просто продолжил комментарий на следующей строке (без TODO). Это не будет включено в список задач, но щелчок по нему приводит меня к исходной строке, где я могу прочитать полный текст. Есть ли конкретная причина, по которой вам нужно больше?   -  person Paŭlo Ebermann    schedule 17.06.2011
comment
Круто, спасибо всем за ваш вклад, что я, по сути, и сделал. Поместите краткое изложение в одну строку с TODO, а затем более подробный комментарий прямо под ним о том, что это повлечет за собой. Спасибо еще раз!   -  person Will Madison    schedule 17.06.2011
comment
/** * TODO Это * многострочный todo * комментарий */   -  person Ravisha    schedule 27.07.2011


Ответы (6)


Пожалуйста, попробуйте с строками ниже,

    /**
     * <pre>
     * TODO : You can write very long line here, which will not truncate in task desc.
     * </pre>
     */
person Vishal Zanzrukia    schedule 26.07.2015
comment
если это работает для вас, вы должны проголосовать за него, чтобы он мог быть полезен другим. :) - person Vishal Zanzrukia; 29.07.2015
comment
Это сработало для меня в Eclipse с Python/PyDev. Я просто использовал синтаксис Python для многострочного комментария, а не одиночного, и это сработало! Спасибо за ответ... из будущего. - person Hildy; 16.05.2018

Я присваиваю TODO короткое название/объяснение. Это название будет выбрано вашей IDE и помещено в список задач для справки. Затем внизу я подробно описываю свое TODO.

Первая строка будет красиво выделена в вашем коде, так что вы также сможете легко распознать встроенную задачу.

/**
*   TODO: Short explanatory title
*   Here I start a more lengthy description.
*   This can consist of as many lines as you want.
*/
person therebelcoder    schedule 13.07.2015
comment
Разве /** обычно не зарезервирован для комментариев JavaDoc? Почему бы не использовать /*? - person Stevoisiak; 21.04.2017
comment
@StevenVascellaro /* называется ограничителем начала комментария и не имеет особого значения (кроме что он начинает комментарий). /** известен как DocBlock или Документальный комментарий. Eclipse использует Javadoc для создания документации API, тогда как Javadoc следует за форматом комментариев для анализа и подготовки кода. - person yckart; 28.05.2017

Я не знаю, может ли это вам помочь, но вы также можете добавить свои собственные настраиваемые теги задач в разделе «Настройки»> «Java»> «Компилятор»> «Теги задач». Таким образом, вы можете отделить теги по умолчанию (автоматически сгенерированные) от ваших собственных тегов, которые вы можете счесть более важными для исправления, чем стандартные теги TODO.

Затем вы также можете настроить представление «Задачи», например, чтобы отображались только ваши собственные пользовательские теги...

person bvanvelsen    schedule 07.12.2011

Вы можете создавать многострочные комментарии TODO следующим образом:

/**
* 
*         TODO This is the first line
*         This is the second line of todo comment
*/
person Aleks    schedule 14.02.2013
comment
это не работает - элемент TODO будет усечен после первой строки. - person specializt; 06.01.2015
comment
* Это больше не работает (если не работает). Это 2016 год - person Aleks; 25.03.2016

 *
 * @TODO this is the first line<br>this is the second line
 * 

Во всплывающих подсказках будет отображаться 2 строки, так как я использовал <br> ;)

person greenseed    schedule 18.06.2016

Кажется, Eclipse не помечает TODO как комментарий, он ищет слово «TODO».

Итак, похоже, вам нужно что-то вроде (по крайней мере, на данный момент):

// TODO:
// TODO:
// TODO:

or

/* TODO:
 * TODO:
 * TODO:
 */

для многострочных TODO

person YTKColumba    schedule 21.08.2011
comment
Это создает 3 отдельных элемента TODO в списке задач. Я не думаю, что это то, что имел в виду ОП. - person Sameer; 29.10.2013