Всех приветствую!
У меня есть предложение, касающееся синтаксиса комментариев, которое может помочь нам в будущем.
Речь идёт о встроенных "TODO"шках (и не только), которые сейчас имеют вид
// что-то там... TODO: и ещё что-то здесь
Интеграция-2008 сейчас подсвечивает тудушку синеньким. Замечательно!
Однако, этого недостаточно, т.к. есть задачи и просто удобства, которые можно заложить уже сейчас, избегая граблей в будущем.
А задачи такие:
Подсветка в IDE. Уже сделано, но потребует переписывания.
Список Task List(Comments) — см. VS2010 + комменты TODO. Очень удобная штука, позволяющая даблкликом оказываться сразу в месте коммента.
Перевод комментов а-ля "TODO: мужики, не удалять!" в международное "TODO: keep it."
Автоматизированный сбор тудушек в багтрекер (why not?).
Итак, предлагается такой вид комментов:
//TODO: casual comment
обычный, внутренний коммент
//TODO#65243: fix division by zero
коммент с номером в багтреке
//TODO: %% блин, объект нулевой!
внутренний (не для трекера) коммент для перевода, превращающийся потом в
//TODO: bitch, object is null!
//TODO#: %% давайте уже это пофиксим?!
коммент для сбора в багтрекер, требующий перевода (после регистрации, номер бага проставляется автоматом в коммент)
//TODO#746238: {Vlad13} %% Я тут немножко накодил...
коммент с номером в багтреке, требующий перевода, автор — Vlad13.
Таким образом, мы имеем структурированные комменты, позволяющие самый гибкий поиск и упрощающие перевод. В случае doc-comments, всё просто:
//TODO: %% doc FormatHardDrive
/// <summary>Она тут это... конвертирует, вощем!</summary>
Вместо кульхацкерского HACK, поставляемого со студией, я пользуюсь тегом ATTN (attention), типа: внимание, нестандартный подход, пояснение и.т.п.
Для тех, кто ещё только собирается перевести лэйбл с джинсов, можно оставлять русский коммент:
//TODO#13: {Matumba} Why we need it? || А зачем нам кузнец?
Я понимаю, что всё это скучно для реальных пацанов, пишущих трёхуровневые макросы, но если не придерживаться порядка, потом будет анальная грусть и печаль.
Высказываем свои обдуманные мысли!
Здравствуйте, matumba, Вы писали:
M>Высказываем свои обдуманные мысли!
1) Ctrl + F -> "TODO"
2)
3)
Здравствуйте, matumba, Вы писали:
M>Всех приветствую!
M>У меня есть предложение, касающееся синтаксиса комментариев, которое может помочь нам в будущем.
На мой взгляд занятие фигней. Нет никаких проблем иметь отдельные пометки кроме "TODO:". Мы и сейчас используем их. Например, когда я пишу TODO, то обычно дописываю свой ник, чтобы народ понимал кто сделал примечание:
// VladD2: TODO: текст...
Где ты тут грабли усмотрел я вообще понять не могу.
Поиск TODO отлично делается по подстроке "TODO:". Подсвечивается только "TODO:". Посему надо не заниматься фигней, а пользоваться тем что есть.
Здравствуйте, hardcase, Вы писали:
H>1) Ctrl + F -> "TODO"
С трудом себе представляю, зачем вам тогда IDE — разве vi недостаточно?
А подсветку в ворде сделаете.
Все эти соглашения — не исправление каких-то граблей (как ошибочно думают некоторые товарищи), а избежание их в будущем + заклад на автоматизацию (тем более, что к существующей практике добавляет буквально два символа). Но если хочется работать руками, а не головой... хорошо, ctrl+f вам в руки.
Здравствуйте, matumba, Вы писали:
M>Все эти соглашения — не исправление каких-то граблей (как ошибочно думают некоторые товарищи), а избежание их в будущем + заклад на автоматизацию (тем более, что к существующей практике добавляет буквально два символа). Но если хочется работать руками, а не головой... хорошо, ctrl+f вам в руки.
Вообще, для этого достаточно сделать комментарий который особо обрабатывается парсером (например ///). И макрос для обработки таких коментариев. Хорошо подойдет для навигации по проекту, как постоянные букмарки. TODO лишь частный случай, в принципе можно спроектировать хорошее окно навигации по таким коментариям, я бы не отказался иметь в проекте кучу закладок с пояснениями.
Только к разработке Н2 это имеет опосредованное отношение, там можно будет любой синтаксис обрабатывать самостоятельно.
