Использование тегов комментариев HACK и UNDONE

Многие разработчики программного обеспечения знакомы с использованием специальных тегов комментариев, которые могут быть добавлены к их кодовым комментариям, для использования в поиске, автоматическом отслеживании задач и т.д. Некоторые из самых популярных - FIXME, TODO, UNDONE и HACK.

Я немного смущен использованием тегов HACK и UNDONE. Немного помогите пожалуйста?

Бонусные баллы за отображение основной разницы между FIXME и TODO

Ответы

Ответ 1

Мое понимание:

  • TODO: Что-то, что нужно сделать. Это может быть функция, которая будет добавлена ​​позже или укажет, что что-то является заглушкой и должно быть реализовано.

  • FIXME: Подкласс тега TODO, указывающий, что что-то сломано, необходимо исправлять.

  • UNDONE: примечание, указывающее изменение, которое было откатом или отменой некоторых других изменений. В этом комментарии обычно указывается, что было удалено и почему.

  • HACK: Что-то, обычно нечетное или неортодоксальное кусочек кода, которое было добавлено для исправления какой-либо конкретной проблемы. Обычно это не "изящные" решения, но тем не менее делают работу штопа. Часто вы увидите, что они устраняют ошибку в структуре или другое непредвиденное поведение. Кроме того, цель прокомментированного кода часто будет неясной, если бы не комментарий.

Ответ 2

UNDONE для меня означает, что метод не завершен, он обычно возвращает тип данных, несмотря на отсутствие внутреннего кода

Я хотел сказать это, потому что некоторые люди считают это разворот, я бы не загрязнял код этими комментариями и чувствовал, что многие другие люди могут использовать UNDONE для обозначения того же, что и я

это либеральный набор правил, но это отличная система

public int SomeCalculation(int Input)
{
  return 0; //UNDONE
}

public bool SomeCheck()
{
  return false; //UNDONE
}