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

/**---------START-----------**/

  //  IMPLEMENTATION GOES HERE

/**---------END-----------**/

, но никакой код;)

В некотором ассемблере, в конце строки, которая содержала &h723

' RIP LVB

(получают его?)

Я думаю, что у меня было что-то вроде этого вида:

if (case1) { // trivial
...
}
else { // we are screwed
 /* fill in later */
}

хорошо, таким образом, я, возможно, использовал более сильное слово, чем завинченный

// Added because boss changed his mind : 20020111,20020501,20020820, ...
// Commented out because boss changed his mind : 20020201,20020614,20020908, ...

В сценарии ETL между главным образом взломанной базой данных RPG и SQL Server один. У меня было что-то как 10 или 20 происшествий этого комментария...

// Hard to explain

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

На самом деле видел это на днях, на некотором коде, который был записан, когда был порыв крайнего срока.

//This was clearly written under duress

// This code was written by a genius so don't try to understand it with
// your tiny little brain.

Выставка a:

return 0; // Happy ending

приложение B:

int32_t Interpolate1DSignal(
  Array1D<float64>::Handle hfInputSamples,         // samples to be interpolated
  Array1D<float64>::Handle hfInterpolationFilter,  // polyphase filter coefficients,
  int32_t iFilterInterpolationFactor,              // # of "rows" in polyphase filter
  int32_t iFilterLength,                           // Length of each row in filter
  float64 fInterpolationFactor,                    // Factor to interpolate the
                                                   // signal by
  float64 fTimingOffset,                           // Offset into the signal (units   
                                                   // of samples)
  Array1D<float64>::Handle hfOutputSamples         // left as an exercise for the reader
);

Я верю в JBoss где-нибудь была строка, которые читают

return null; //Not really null

, мне всегда нравилась та строка.

//The following code is commented out
//(a load of commented out code followed)

i++; // increment variable i

От классик от usenet:

Глубокий в аппаратном коде средства моделирования Teradyne стандартная программа, которая подает целый набор шестнадцатеричных чисел в вызов SYS$QIO. Единственный комментарий является 'Странным волшебством, происходит здесь'.

В заголовке файла кода, в большой степени отредактированного всеми на команде разработчиков:

'Avert your eyes, it may take on other forms!

Старая добрая Фландрия.

// Okay, let's do the loop, yeah come on baby let's do the loop
// and it goes like this ...

Этот я нашел его в пакете "скрученным" для Python 2.5 (файл является tcp.py в строке 371)

# Limit length of buffer to try to send, because some OSes are too
# stupid to do so themselves (ahem windows)
return self.socket.send(buffer(data, 0, self.SEND_LIMIT))

От Apache исходный код Xalan:

/**
 * As Gregor Samsa awoke one morning from uneasy dreams he found himself
 * transformed in his bed into a gigantic insect. He was lying on his hard,
 * as it were armour plated, back, and if he lifted his head a little he
 * could see his big, brown belly divided into stiff, arched segments, on
 * top of which the bed quilt could hardly keep in position and was about
 * to slide off completely. His numerous legs, which were pitifully thin
 * compared to the rest of his bulk, waved helplessly before his eyes.
 * "What has happened to me?", he thought. It was no dream....
 */
protected static String DEFAULT_TRANSLET_NAME = "GregorSamsa";

Дополнительные материалы для чтения на The Daily WTF.

Однажды, я спросил коллегу, как сделать что-то (забыл точно что, некоторые неясные технические вызовы) с нашей внутренней платформой. Он сказал "легкий, посмотрите ЗДЕСЬ", затем открывает .java файл в его редакторе и показывает мне этот комментарий посреди нескольких страниц кода:

// HERE

я просто проверил, комментарий находится все еще там в этом файле :)

// this error could never happen

И затем - вызов клиента, говоря он видит, что в сообщении об ошибке говорится, что "этой ошибки никогда не могло происходить"

// A Gorgon class - For the love of Zeus don't look directly at it!

 /**
   * Returns cookies according to the filters specified.
   * 
   * @return array  Cookies!  Nom nom nom nom nom.
   */
 public function data_getCookies($uid, $name) {

Где-нибудь от API Facebook.

// If I from the future read this I'll back in time and kill myself. 

// Это сэкономит нам ~ 0,5 секунды для каждого пользователя и пожалуйста, духи машины.

Перед очень долгой процедурой:)

Когда я учился в старших классах на уроке CS, нас учили в обычном классе - без компьютеров. Все наши тесты проводились на бумаге, которую мы сдавали - один класс на лист бумаги. Наш учитель впервые преподавал на С ++ и иногда переходил в режим Паскаля на доске. Это было неловко, так как мало кто из нас интересовался изучением Паскаля.

Для больших, чем на уроках, мы делали бы их дома и сдавали распечатки кода + вывода для оценки. После представления нескольких распечаток кода и вывода мы все вместе поняли, что учитель на самом деле не читает код - только распечатки. Чтобы проверить нашу теорию, я поместил комментарий на 3-й странице моего кода - прямо между объявлениями некоторых классов:

// If you are reading this, please place a checkmark here [  ]

Конечно, я получил его с большой синей буквой «А»

Первые две строки файла с именем мониторинг.sh:

#!/usr/bin/perl
# perl script disguised as a bash script

else
{
    // rien, c'est parfait.
}

/**
 * Happy Javadoc haiku:
 *
 * Without Javadoc
 * Builds break in Maven site stage
 * This fixes the build.
 */

Этот от Xee, браузера изображений.

    // At this point, I'd like to take a moment to speak to you about the Adobe PSD format.
    // PSD is not a good format. PSD is not even a bad format. Calling it such would be an
    // insult to other bad formats, such as PCX or JPEG. No, PSD is an abysmal format. Having
    // worked on this code for several weeks now, my hate for PSD has grown to a raging fire
    // that burns with the fierce passion of a million suns.
    // If there are two different ways of doing something, PSD will do both, in different
    // places. It will then make up three more ways no sane human would think of, and do those
    // too. PSD makes inconsistency an art form. Why, for instance, did it suddenly decide
    // that *these* particular chunks should be aligned to four bytes, and that this alignement
    // should *not* be included in the size? Other chunks in other places are either unaligned,
    // or aligned with the alignment included in the size. Here, though, it is not included.
    // Either one of these three behaviours would be fine. A sane format would pick one. PSD,
    // of course, uses all three, and more.
    // Trying to get data out of a PSD file is like trying to find something in the attic of
    // your eccentric old uncle who died in a freak freshwater shark attack on his 58th
    // birthday. That last detail may not be important for the purposes of the simile, but
    // at this point I am spending a lot of time imagining amusing fates for the people
    // responsible for this Rube Goldberg of a file format.
    // Earlier, I tried to get a hold of the latest specs for the PSD file format. To do this,
    // I had to apply to them for permission to apply to them to have them consider sending
    // me this sacred tome. This would have involved faxing them a copy of some document or
    // other, probably signed in blood. I can only imagine that they make this process so
    // difficult because they are intensely ashamed of having created this abomination. I
    // was naturally not gullible enough to go through with this procedure, but if I had done
    // so, I would have printed out every single page of the spec, and set them all on fire.
    // Were it within my power, I would gather every single copy of those specs, and launch
    // them on a spaceship directly into the sun.
    //
    // PSD is not my favourite file format.

Tweet tweet = (Tweet) tweets.get(i); // Poetic.

//BELOW IS THE REAL CODE...JABRONI
        //
        // Yeah, but can you play the outtro to Bark At The Moon?
        //

        //|--------------------------------------------------|------------------------------------------------|
        //|--------------------------------------------------|------------------------------------------------|
        //|--17^16-16-16-17^16-17^16-16-16-17^16-17^16----16-|-19^16----16-19^16-19^16---16-19^16-19^16----17-|
        //|--------------------------------------------19----|-------17----------------17---------------17----|
        //|--------------------------------------------------|----------------------------------------------

//todo: never to be implemented