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

Этот был забавен для других, но меньше для меня. Я наследовал код (который был ASP) от разработчика, который самостоятельно наследовал его. Первый программист создал некоторых очень трудно для понимания кода. Второй разработчик добавил, комментарий следующим образом (называет скрытым для защиты not-so-innocent):

'This code was written by **************.
'I haven't a clue what it does. He hasn't a clue what it does.
'Nobody else has a clue what it does or how it does it.
'It is something to do with data but **** knows what.
'The ******* still works so please do not change this code,
'even though it is a complete pile of ****.

Итак, почему я не нашел это забавным? Ну, это был код ASP для интранет клиента.

... и это был клиент, который выделил комментарий мне.

:-(

// HACK ! COPY/PASTE this and look for another job

Из сценария CGI Perl прежней версии:

# This is convoluted and evil, sorry.

Я не встретился с этим непосредственно, но это делает для хорошей истории (см. объяснение в моем комментарии):

#define MSGTAG_B33R     0x723 /* RIPLVB */

' Oh man I'm pissed. I think I better go home.

, где pissed = выпитый

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

, Что каждый Donald Knuth.

// set break point here - you'll never reach it

/* logic */
#ifndef TRUE
# define TRUE 1
#endif /* TRUE */
#ifndef FALSE
# define FALSE 0
#endif /* FALSE */
#define EOF_OK TRUE
#define EOF_NOT_OK FALSE

и остальная часть великолепного mkentry.c в страница IOCCC. Я не могу продолжать смеяться каждый раз, когда я прочитал этот источник.

// but the "real" solution is much more complicated

от jpgraph

Тот известен, но мне нравится он (в sys/ufs/ufs_vnops.c):

/*
 * A virgin directory (no blushing please).
 */

в исходном дереве ядра FreeBSD (и даже прежде, назад в 4.xBSD)

Долгое время назад я столкнулся с некоторым сценарием соединения и в то время как я не помню синтаксис, я действительно вспоминаю комментарии, поскольку я - поклонник Pink Floyd.

//Attempt Handshake: Hello? This is London calling. Are we reaching you?


//Handshake Failed: I don't understand...he just hung up.

Не в коде, а в связанной bugtracking системе:

Это не может быть ошибкой в моем коде. Я кодировал его очень тщательно.

Я нашел это:

I'm not sure what I did

От C#

#region Hack - Shield Eyes Before Expanding

/// <summary>
/// A single uint with all of the bits set to represent the different tracing
/// </summary>
/// <remarks>
/// Ugly I know, so if you can think of a better way, feel free to rewrite.
/// </remarks>
[Browsable(false)]
public uint TraceBitfield
{
    // Snip
}

#endregion

Я просто столкнулся с этим в части моего собственного кода. Это было в магнитном администраторском шаблоне для выбора категории:

        /*
         * OK; before you read the following code know what I am trying to do.
         * I needed to get the list of child catagories from the root node so that
         * the root node didn't appear in the selection box. But for some stupid
         * fucking reason the stupid fucking DBA wont let me access the items using
         * indicies and I instead have to use their stupid fucking Iterator
         * implementation. So there.
         */
        $firstList = $this->getRootNode()->getChildren();
        foreach ($firstList as $node)
        {
            $nodes = $node->getChildren();
            break;          // wtf?
        }

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

В классе под названием "Панель" (который был Управлением UI с меньше, чем описательное имя), заголовок класса:

/// <summary>I pity the "foo".</summary>

И Remove() метод:

/// <summary>A "foo" and his money are soon parted.</summary>

Еще хуже, это был деловой партнер, который указал на него из сгенерированной документации. Еще хуже, чем это, те - вероятно, самые близкие вещи к полезной документации, мы когда-либо выходили из парня.

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

//this used to be a comment

//Not a bug, parameter position can change..., if you think this is wrong, you are in fact wrong.

/*
* TODO: Remove this function

function remove($customer_id)
    {
        $this->Customer->remove($id);
    }

*/

BEGIN.
// Here might be dragons
.
.
 IF...
 // Beware of the Jabberwocky
 .//user the force, luke
 .
 .
 ENDIF.
.
END.

var something TBoolean; //Pickins

#!/usr/bin/sh
#       Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T
#         All Rights Reserved

#       THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF AT&T
#       The copyright notice above does not evidence any
#       actual or intended publication of such source code.

#ident  "@(#)false.sh   1.6     93/01/11 SMI"   /* SVr4.0 1.3   */
exit 255

Взято из SunOS 5.9 или Solaris 9 (/ usr / bin / false)

//too much log will kill you

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

Много лет назад я подобрался к работе, чтобы оказать поддержку проекту, который реально работал время на Z80 и был в сборке (есть ли другой способ сделать Z80 ??) Во всяком случае, первоначальным автором был нигерийский парень по имени Моисей. Может быть, я должен просто остановить там. Во всяком случае, разбросанные по всему коду, были следующие:

XRA A    ;MT

Мне потребовалось некоторое время, чтобы понять, что это было. Сама инструкция больше ничего не делает чем очистить аккумулятор. Это скользкий путь, хотя я не уверен, есть ли преимущество или нет. Вы можете просто сделать:

LDA 0

Но, может быть,

XRA A

сохраняет байт или что-то в этом роде. Что делает эксклюзив или аккумулятор с собой. Результат, конечно, всегда ноль.

Назад к МП - Пусто (понятно?)

Это лучшее, с чем я столкнулся.

В пачке плохо вырезанного и вставленного исходного кода для веб-приложения управления контентом:

// load image 1 - JPEG 240x320
img = f1.getImage();
if (check(img))
{
   load(img, Constants.JPEG_240x320);
}

// load image 2 - JPEG 128x128
img = f2.getImage();
if (check(img))
{
   load(img, Constants.JPEG_128x128);
}

...

// load image 13 - GIF 256x256
img = f13.getImage();
if (check(img))
{
   load(img, Constants.GIF256x256);
}

// loaded all of the f**king images

примечание: грубо переведено с итальянского: -)

// woot, global var. I havent done this for a long time.

моим любимым было что-то вроде этого

 # commented out
 ...
 ### end of the formerly uncommented #2001-02-22 John Doe

public static final void attachListener(Object listener) {

/* ======================= */

// This does nothing, continue searching

/* ======================= */

...

больно слушателям!

/* Only break the connection if it actually exists. It is important to
 * check the timeslot saved in the SOURCE of the disconnect message. */

Я написал этот комментарий, и теперь я не могу вспомнить, ПОЧЕМУ это важно ...

// All this code is yours, except gedit()...attempt no modifications there.