Каков лучший комментарий в исходном коде, с которым Вы когда-либо встречались? [закрытый]

Spelunking через Уровень аппаратной абстракции при работе на определенного финского Производителя оборудования Сети мобильной связи я нашел 100 + случаи финского слова "puukko".

А 'puukko' является всем ножом цели, который каждый финн имеет на их панели инструментов или вокруг дома. Это используется для всего от очищения картофеля к работающим ремонтам компьютера (мои наблюдения). Я верю в этот контекст, это - финский эквивалент слова 'Hack'.

Мои финские коллеги отклонили это и сказали, что это означало что-то больше как 'операция / вмешательство'..., и я почти верил им, пока я не нашел комментарий:

/* Perkele ISO Puukko! */ -> Fucking Big Hack!

Некоторые из очень немногих комментариев в 5 000 + строки кода в одном файле
, у меня на самом деле есть спор с кодером, который защитил его стиль кодирования...
Никакой комментарий!
И не было никаких комментариев;-) (или очень немногие)
Печально это - производственный код.

offset=1;
for (i=0;i<=len;i++)
    {
    if ((i!=0)&&(i<len)) //-3
        {
        switch(mess[i])
            {
            case ETX:
            case ETB:
            case DLE:
                buf[offset]=DLE;
                offset++;
                break;
            }
        }
    buf[offset]=mess[i];
    offset++;
    }

я люблю переключатель!

for (n=0;n<offset;n++)
{
    Sleep(TR);  //Modif A
    Sleep(T);//
    FWriteFile(hCom,buf+n,1,&dwMot,NULL);
    if (ECHO)
        FReadFile(hCom,tab,1,&dwMot,NULL);
}

и не, нет никаких комментариев, объясняющих, что "modif" находится в заголовке.

if (GetFileSize(hSlotFile,NULL)==3600)   //5*720

и что 720?

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

try
{               
    // Some database logic
}
catch (Exception $ex)
{
    // sure, it looks silly and I honestly cant remember what code used to go here... but i swear i will
    // find a use for this code.... eventually....
    throw $ex;
}

i++; //increment i

// insert comment here

В LKM:

/*
* Dear Richard Stallman,
*
* This one's for you.
*
* Sincerely,
* Me
*
*/
MODULE_LICENSE( "GPL" );

 // WARNING!!!
 // Very perversive code ahead!

... about a 20 lines of "very perversive" code ...

// Now you can call your grandmother back. ;)

Новый из колледжа, я стремился пачкать руки. Моя первая задача была..., "комментирует этот код для меня".

Распутник.

Спустя некоторое время я скучал с ним...

// this function doesn't actually calculated the profit, like it says --it really signals the mothership orbiting saturn that the planet is ripe for takeover

[later]

// I don't think anyone is going to read this

[various permutations on that last one]

Едва ли комментарий:

DvLog::Log("This silly log message fixes a PSCRIPT5.DLL gpf when printing to Adobe.");

Печальная вещь состоит в том, что без комментария, PSCRIPT5.DLL действительно аварийно завершался...

Забавная опечатка, которая была странно соответствующей:

assert(0); // should never shit this point

Спустя несколько часов после показа друга это сообщение от Кодирования Ужаса , я видел этот комментарий к его коду:

//MrValdez является жестоким Психопатом. Не бесите его.

После того, чтобы быть вынужденным записать модульные тесты на анемичные объекты области, которые являются только мешками методов get и методов set (который я был вынужден записать также):

// zzzzZZZZzzzz....

<!-- THIS IS THE MAIN CONFIGURATION FILE FOR THE ENTIRE BLOODY DIRECTORY    -->
<!--    WHATEVER YOU DO, DO NOT EDIT THIS FILE WITHOUT TALKING TO ME FIRST  -->
<!--                                I'M SERIOUS                             -->
<!-- (scroll down) -->

// I love the smell of dirty XML in the morning
xml = xml.Replace("xmlns=\"urn:bsd.orion/inventory\"", "");

От класса поблочного тестирования в C#:

#region quis custodiet ipsos custodes?

[Fact]
public void TestPositive()
{
    Assert.Equal(4, 2 + 2);
}

[Fact]
public void TestNegative()
{
    Assert.Equal(5, 2 + 2);
}

#endregion

У меня больше нет точного пакета кода, но я помню комментарий ярко.

// The code below needs to be changed immediately.
// I wish I was a little bit taller
// I wish I was a baller
// I wish I had a girl who looked good, I would call her.

catch (Exception ex)
{ 
    // just die already.
}

# Don use this. Never!

// This condition can't happen. Call the police or something.

var arbitraryNumber = 10;
//I don't know why. Just move on.

#ifdef TRACE
#undef TRACE     /* All your trace are belong to us. */
#endif
#define TRACE ....

// Это сбивает с толку, Я ЗНАЮ, поэтому позвольте мне вам это объяснить.

Я недавно видел это:

// вы только что проиграли

, если не знаете что это за игра: http://en.wikipedia.org/wiki/The_Game_ (mind_game) (это очень глупо, но глупо интересным способом)

Recompiling FreeTextBox3 for the first time in our application because we need IE8 support... And look what I've found:

// IE7 update. this is still bad code, but IE8 is probably a long way off :)

# dont question, i just felt like throwing some globals in
# this is actually quite pointless as youll soon see

позже в коде

#draw the circles (complicated)...dont question

даже позже ...

# complicated process of drawing the circles in a
# somewhat symmetrical, 3-d pattern
# dont question again

и даже позже ...

# will determine if user clicks on die
# i determined these values...dont worry about them

Я видел этот код в функции ПОЛНОСТЬЮ явных странных приведений:

// Since today's CPUs are really fast, this is dedicated to those who said:
// " You can't use Moore's Law as an excuse to write bad software. "

Код был ужасным:)

// *** drunk -- fix later ***

прямая ссылка

Больше удовольствия с поиском по коду Google ...

//Dave chapelle reports errors.
function reporterror() {
  davechapelle.trace("FUCK!");
}

// TODO: Finish.

// без комментариев