На StackOverflow был отличный пост точно на эту тему, но какой-то сверхусердный модератор, который должен остаться неназванным, удалил его (судя по всему, сейчас восстановлено — прим. пер.).
К счастью, у меня сохранилась возможность просмотреть все удаленные комментарии. Вот некоторые из моих любимых.
(Изначально цитату приписывают Карлу Вейерштрассу, относительно его математической статьи).
(Так банально, что даже смешно).
Долговязый Джон Сильвер (Long John Silver) — персонаж романа Роберта Льюиса Стивенсона «Остров сокровищ» — прим. пер.
(Это даже компилируется в C99/C++0x).
(Это доказывает, почему код *всегда* лучше, чем комментарии)
К счастью, у меня сохранилась возможность просмотреть все удаленные комментарии. Вот некоторые из моих любимых.
//
// Дорогой мейнтейнер:
//
// Когда ты закончишь «оптимизировать» эту подпрограмму
// и поймешь, насколько большой ошибкой было делать это,
// пожалуйста, увеличь счетчик внизу как предупреждение
// для следующего парня:
//
// total_hours_wasted_here = 42
//
// Когда я начинал это писать, только Бог и я понимали, что я делаю
// Сейчас остался только Бог
(Изначально цитату приписывают Карлу Вейерштрассу, относительно его математической статьи).
// иногда мне кажется, что компилятор игнорирует все мои комментарии
// Я посвящаю весь свой код, всю работу своей жене Дарлин, которой
// придётся содержать меня, наших троих детей и собаку, когда
// это пойдет в паблик.
// пьян, исправить позже
// Магия. Не трогать.
#define TRUE FALSE
// Удачного дебаггинга, молокососы
long john; // silver
(Так банально, что даже смешно).
Долговязый Джон Сильвер (Long John Silver) — персонаж романа Роберта Льюиса Стивенсона «Остров сокровищ» — прим. пер.
long long ago; /* в далёкой-далёкой Галактике */
(Это даже компилируется в C99/C++0x).
/**
* Всегда возвращает true.
*/
public boolean isAvailable() {
return false;
}
(Это доказывает, почему код *всегда* лучше, чем комментарии)
<!-- Here be dragons -->