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

... или умри // сука

Попробуйте ввести свою любимую ненормативную лексику в поиск по коду Google, это быстро проведет унылый час. Некоторые из моих любимых примеров:

/* These magic numbers are fucking stupid. */

/* Dear free software world, do you NOW see we are fucking
   things up?! This is insane! */

/* We will NOT put a fucking timestamp in the header here. Every
   time you put it back, I will come in and take it out again. */

# However, this only works if there are MULTIPLE checkboxes!
# The fucking JS DOM *changes* based on one or multiple boxes!?!?!
# Damn damn damn I hate the JavaScript DOM so damn much!!!!!!

/* TODO: this is obviously not right ... this whole fucking module
   sucks anyway */

/* FIXME: please god, when will the hurting stop? Thus function is so
   fucking broken it's not even funny. */

и мой личный фаворит

 # code below replaces code above - any problems?
 # yeah, it doesn't fucking work.

При инициализации связанного списка:

last = first; /* Biblical reference */

Лаконично и весело.

Кто-то жаловался, что «лучший» комментарий содержит худшие комментарии. ИМХО, они смешнее и так «лучше», но вот честный лучший комментарий, который я когда-либо делал читать:

/*
Major subtleties ahead:  Most hash schemes depend on having a "good" hash
function, in the sense of simulating randomness.  Python doesn't:  its most
important hash functions (for strings and ints) are very regular in common
cases:

>>> map(hash, (0, 1, 2, 3))
[0, 1, 2, 3]
>>> map(hash, ("namea", "nameb", "namec", "named"))
[-1658398457, -1658398460, -1658398459, -1658398462]
>>>

This isn't necessarily bad!  To the contrary, in a table of size 2**i, taking
the low-order i bits as the initial table index is extremely fast, and there
are no collisions at all for dicts indexed by a contiguous range of ints.
The same is approximately true when keys are "consecutive" strings.  So this
gives better-than-random behavior in common cases, and that's very desirable.

OTOH, when collisions occur, the tendency to fill contiguous slices of the
hash table makes a good collision resolution strategy crucial.  Taking only
the last i bits of the hash code is also vulnerable:  for example, consider
[i << 16 for i in range(20000)] as a set of keys.  Since ints are their own
hash codes, and this fits in a dict of size 2**15, the last 15 bits of every
hash code are all 0:  they *all* map to the same table index.

But catering to unusual cases should not slow the usual ones, so we just take
the last i bits anyway.  It's up to collision resolution to do the rest.  If
we *usually* find the key we're looking for on the first try (and, it turns
out, we usually do -- the table load factor is kept under 2/3, so the odds
are solidly in our favor), then it makes best sense to keep the initial index
computation dirt cheap.

The first half of collision resolution is to visit table indices via this
recurrence:

    j = ((5*j) + 1) mod 2**i

For any initial j in range(2**i), repeating that 2**i times generates each
int in range(2**i) exactly once (see any text on random-number generation for
proof).  By itself, this doesn't help much:  like linear probing (setting
j += 1, or j -= 1, on each loop trip), it scans the table entries in a fixed
order.  This would be bad, except that's not the only thing we do, and it's
actually *good* in the common cases where hash keys are consecutive.  In an
example that's really too small to make this entirely clear, for a table of
size 2**3 the order of indices is:

    0 -> 1 -> 6 -> 7 -> 4 -> 5 -> 2 -> 3 -> 0 [and here it's repeating]

If two things come in at index 5, the first place we look after is index 2,
not 6, so if another comes in at index 6 the collision at 5 didn't hurt it.
Linear probing is deadly in this case because there the fixed probe order
is the *same* as the order consecutive keys are likely to arrive.  But it's
extremely unlikely hash codes will follow a 5*j+1 recurrence by accident,
and certain that consecutive hash codes do not.

The other half of the strategy is to get the other bits of the hash code
into play.  This is done by initializing a (unsigned) vrbl "perturb" to the
full hash code, and changing the recurrence to:

    j = (5*j) + 1 + perturb;
    perturb >>= PERTURB_SHIFT;
    use j % 2**i as the next table index;

Now the probe sequence depends (eventually) on every bit in the hash code,
and the pseudo-scrambling property of recurring on 5*j+1 is more valuable,
because it quickly magnifies small differences in the bits that didn't affect
the initial index.  Note that because perturb is unsigned, if the recurrence
is executed often enough perturb eventually becomes and remains 0.  At that
point (very rarely reached) the recurrence is on (just) 5*j+1 again, and
that's certain to find an empty slot eventually (since it generates every int
in range(2**i), and we make sure there's always at least one empty slot).

Selecting a good value for PERTURB_SHIFT is a balancing act.  You want it
small so that the high bits of the hash code continue to affect the probe
sequence across iterations; but you want it large so that in really bad cases
the high-order hash bits have an effect on early iterations.  5 was "the
best" in minimizing total collisions across experiments Tim Peters ran (on
both normal and pathological cases), but 4 and 6 weren't significantly worse.

Historical:  Reimer Behrends contributed the idea of using a polynomial-based
approach, using repeated multiplication by x in GF(2**n) where an irreducible
polynomial for each table size was chosen such that x was a primitive root.
Christian Tismer later extended that to use division by x instead, as an
efficient way to get the high bits of the hash code into play.  This scheme
also gave excellent collision statistics, but was more expensive:  two
if-tests were required inside the loop; computing "the next" index took about
the same number of operations but without as much potential parallelism
(e.g., computing 5*j can go on at the same time as computing 1+perturb in the
above, and then shifting perturb can be done while the table index is being
masked); and the dictobject struct required a member to hold the table's
polynomial.  In Tim's experiments the current scheme ran faster, produced
equally good collision statistics, needed less code & used less memory.

Theoretical Python 2.5 headache:  hash codes are only C "long", but
sizeof(Py_ssize_t) > sizeof(long) may be possible.  In that case, and if a
dict is genuinely huge, then only the slots directly reachable via indexing
by a C long can be the first slot in a probe sequence.  The probe sequence
will still eventually reach every slot in the table, but the collision rate
on initial probes may be much higher than this scheme was designed for.
Getting a hash code as fat as Py_ssize_t is the only real cure.  But in
practice, this probably won't make a lick of difference for many years (at
which point everyone will have terabytes of RAM on 64-bit boxes).
*/

int MyFunction()
{
    // There once was a man named Dave
    int Result = 0;

    // Whose code just wouldn't behave
    MyObject *Ptr = new MyObject();

    // He left to go to a meetin'
    Result = Ptr->DoSomething();

    // And left his memory a leakin'
    return Result;
}

Комментарий C ++

Из утечки Windows 2004 г.

__inline BOOL
SearchOneDirectory(
                  IN  LPSTR Directory,
                  IN  LPSTR FileToFind,
                  IN  LPSTR SourceFullName,
                  IN  LPSTR SourceFilePart,
                  OUT PBOOL FoundInTree
                  )
{
    //
    // This was way too slow. Just say we didn't find the file.
    //
    *FoundInTree = FALSE;
    return(TRUE);
}

Я видел этот комментарий к чьему-то коду:

// This comment is self explanatory.

Я предполагаю, что он хотел сказать «переменная», но из-за ошибки был сделан один забавный комментарий ... Подумайте о круговой логике здесь и о бесполезности ее написания.

Не совсем комментарий, а ярлык goto

ICantBelieveImUsingAGoto:

Рядом с локальной переменной, которую нужно было объявить только для передачи константы библиотечной функции:

// This only exists because Scott doesn't know how to use const correctly

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

// UNUSED
// Separate into p_slidoor.c?

#if 0           // ABANDONED TO THE MISTS OF TIME!!!
//
// EV_SlidingDoor : slide a door horizontally
// (animate midtexture, then set noblocking line)
//

Взято из источника Quake III, я наткнулся на это в какой-то случайной публикации на слэшдоте. Полный источник файла можно найти на здесь. Это особенно быстрый метод вычисления обратного квадратного корня. Что насчет лучшего комментария? Конечно, это обычное дело, но, учитывая то, что он прикреплен к линии, которая творит чудеса, именно то, что делает его отличным.

float Q_rsqrt( float number )
{
  long i;
  float x2, y;
  const float threehalfs = 1.5F;

  x2 = number * 0.5F;
  y  = number;
  i  = * ( long * ) &y;  // evil floating point bit level hacking
  i  = 0x5f3759df - ( i >> 1 ); // what the fuck?
  y  = * ( float * ) &i;
  y  = y * ( threehalfs - ( x2 * y * y ) ); // 1st iteration
  // y  = y * ( threehalfs - ( x2 * y * y ) ); // 2nd iteration, this can be removed

  #ifndef Q3_VM
  #ifdef __linux__
    assert( !isnan(y) ); // bk010122 - FPE?
  #endif
  #endif
  return y;
}

// John! If you'll svn remove this once more,
// I'll shut you, for God's sake!
// That piece of code is not “something strange”!
// That is THE AUTH VALIDATION.

И что ты думаешь? Приведенный ниже код был благополучно удален с помощью svn.

это несколько раз появлялось в моем собственном коде. очевидно, не раз трогал:

// TODO: Fix this.  Fix what?

//MailBody builders for two outgoing messages
StringBuilder hanz = new StringBuilder();
StringBuilder franz = new StringBuilder();

Я все еще немного хихикаю, когда читаю это ...

уйдя с последней работы, я встроил в исходник немного ascii-арта ...

                                      ,_-=(!7(7/zs_.             
                                   .='  ' .`/,/!(=)Zm.           
                     .._,,._..  ,-`- `,\ ` -` -`\\7//WW.         
                ,v=~/.-,-\- -!|V-s.)iT-|s|\-.'   `///mK%.        
              v!`i!-.e]-g`bT/i(/[=.Z/m)K(YNYi..   /-]i44M.       
            v`/,`|v]-DvLcfZ/eV/iDLN\D/ZK@%8W[Z..   `/d!Z8m       
           //,c\(2(X/NYNY8]ZZ/bZd\()/\7WY%WKKW)   -'|(][%4.      
         ,\\i\c(e)WX@WKKZKDKWMZ8(b5/ZK8]Z7%ffVM,   -.Y!bNMi      
         /-iit5N)KWG%%8%%%%W8%ZWM(8YZvD)XN(@.  [   \]!/GXW[      
        / ))G8\NMN%W%%%%%%%%%%8KK@WZKYK*ZG5KMi,-   vi[NZGM[      
       i\!(44Y8K%8%%%**~YZYZ@%%%%%4KWZ/PKN)ZDZ7   c=//WZK%!      
      ,\v\YtMZW8W%%f`,`.t/bNZZK%%W%%ZXb*K(K5DZ   -c\\/KM48       
      -|c5PbM4DDW%f  v./c\[tMY8W%PMW%D@KW)Gbf   -/(=ZZKM8[       
      2(N8YXWK85@K   -'c|K4/KKK%@  V%@@WD8e~  .//ct)8ZK%8`       
      =)b%]Nd)@KM[  !'\cG!iWYK%%|   !M@KZf    -c\))ZDKW%`        
      YYKWZGNM4/Pb  '-VscP4]b@W%     'Mf`   -L\///KM(%W!         
      !KKW4ZK/W7)Z. '/cttbY)DKW%     -`  .',\v)K(5KW%%f          
      'W)KWKZZg)Z2/,!/L(-DYYb54%  ,,`, -\-/v(((KK5WW%f           
       \M4NDDKZZ(e!/\7vNTtZd)8\Mi!\-,-/i-v((tKNGN%W%%            
       'M8M88(Zd))///((|D\tDY\\KK-`/-i(=)KtNNN@W%%%@%[           
        !8%@KW5KKN4///s(\Pd!ROBY8/=2(/4ZdzKD%K%%%M8@%%           
         '%%%W%dGNtPK(c\/2\[Z(ttNYZ2NZW8W8K%%%%YKM%M%%.          
           *%%W%GW5@/%!e]_tZdY()v)ZXMZW%W%%%*5Y]K%ZK%8[          
            '*%%%%8%8WK\)[/ZmZ/Zi]!/M%%%%@f\ \Y/NNMK%%!          
              'VM%%%%W%WN5Z/Gt5/b)((cV@f`  - |cZbMKW%%|          
                 'V*M%%%WZ/ZG\t5((+)L\'-,,/  -)X(NWW%%           
                      `~`MZ/DZGNZG5(((\,    ,t\\Z)KW%@           
                         'M8K%8GN8\5(5///]i!v\K)85W%%f           
                           YWWKKKKWZ8G54X/GGMeK@WM8%@            
                            !M8%8%48WG@KWYbW%WWW%%%@             
                              VM%WKWK%8K%%8WWWW%%%@`             
                                ~*%%%%%%W%%%%%%%@~               
                                   ~*MM%%%%%%@f`                 
                                       '''''                     

Не помню, где я это видел:

long time; /* know C */

и (в коде для создания своего рода демона UNIX):

/* Be a real daemon: fork myself and kill my parent */

Вверху файла заголовка:

/* Project : XYZ (Please somebody shoot me!)
 *
 * File : $Id: defs.h,v 1.1 $
 *
 * Purpose : Create havoc rather than peace among many nations
 *
 * History : Back-ported changes that were not in CVS.  Please somebody,
 *  shoot us and put us all out of our misery.
 */

«Проект XYZ» (название изменено) был семилетним испытанием. Этот последний комментарий был написан одной стойкой душой, которая участвовала с самого начала до конца.

В драйверах / net / sunhme.c (ядро Linux):

/* Welcome to Sun Microsystems, can I take your order please? */
if(!hp->happy_flags & HFLAG_FENABLE)
        return happy_meal_bb_write(hp, tregs, reg, value);

/* Would you like fries with that? */
hme_write32(hp, &tregs->frame,
            (FRAME_WRITE | (hp->paddr << 23) |
             ((reg & 0xff) << 18) | (value & 0xffff)));
while(!(hme_read32(hp, &tregs->frame) & 0x10000) && --tries)
        udelay(20);

/* Anything else? */
if(!tries)
        printk(KERN_ERR "happy meal: Aieee, transceiver MIF write bolixed\n");

/* Fifty-two cents is your change, have a nice day. */

// Catching exceptions is for communists

Со страницы Майка Дункана на SQLite.

Комментарий, который я добавил к PHP CMS, над которым я работал некоторое время назад.

if (/*you*/ $_GET['action']) { //celebrate

Однажды я увидел в другом обсуждении что-то вроде этого:

// I can't divide with zero, so I have to divide with something very similar
result = number / 0.00000000000001;

Умное решение, не правда ли :)? (Это шутка, если кто-то не уверен)

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

public class Contact
{
    //...    

    /// <summary>
    /// Gets or sets the name of the first.
    /// </summary>
    /// <value>The name of the first.</value>
    public string FirstName
    {
        get { return _firstName; }
        set { _firstName = value; }
    }
}

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

//I wonder if she actually reads these.

Когда задание было возвращено, красным карандашом рядом с этим комментарием "Да, я верю"

Отличный вариант из утекшего исходного кода Windows 2000:

!!!!!!! ЕСЛИ ВЫ МЕНЯЕТЕ ТАБЛИЦЫ НА ПРОБЕЛЫ, ВАС УБИВАЕТСЯ !!!!!!! *
!!!!!!!!!!!!!! ДЕЙСТВИЕ ТАКОЕ НАБИРАЕТ ПРОЦЕСС СТРОИТЕЛЬСТВА !!!!!!!!!!!!!!!! *
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!

http://www.kuro5hin.org/story/2004/2/15/71552/7795

Мне всегда нравилось то, что Пол Дилашиа писал в своих заголовках файлов:

// If this code works, it was written by Paul DiLascia. If not, I don't know
// who wrote it

// human madable inconvenient. Way too sucks.

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

// error codes
#define ERROR_SUCESS 0
#define ERROR_SUCCESS_IS_MISSPELLED 1

Другие коды ошибок не определены.

Из модуля монитора батареи во встроенной системе:

// batmon.c drives the rastamobile

Из утекшего исходного кода Windows 2000:

// The magnitude of this hack compares favorably with that of the national debt.

Еще одна классика Дональда Кнута, не менее:

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

В планировщике ядра linux 1.0 (sched.c):

Дейкстра, наверное, меня ненавидит.

/*
 *  'schedule()' is the scheduler function. It's a very simple and nice
 * scheduler: it's not perfect, but certainly works for most things.
 * The one thing you might take a look at is the signal-handler code here.
 *
 *   NOTE!!  Task 0 is the 'idle' task, which gets called when no other
 * tasks can run. It can not be killed, and it cannot sleep. The 'state'
 * information in task[0] is never used.
 *
 * The "confuse_gcc" goto is used only to get better assembly code..
 * Dijkstra probably hates me.
 */
asmlinkage void schedule(void)

(...)

// This procedure is really good for your dorsolateral prefrontal cortex.

Для тех из вас, кто по какой-то особой причине не знает о DPC, это часть вашего мозга, которая загорается, когда вы глубоко заняты изучением чего-то нового.

//ALL YOUR BASE ARE BELONG TO US

... это заставило моего босса подумать, что кто-то взломал его. Он не знал шутки.

Верх исходных файлов sqlite:

/*

** The author disclaims copyright to this source code.  In place of             
** a legal notice, here is a blessing:                                          
**                                                                              
**    May you do good and not evil.                                             
**    May you find forgiveness for yourself and forgive others.                 
**    May you share freely, never taking more than you give.

*/

Я разместил это «лицензионное заявление» в выпущенном мной шаблоне WordPress. Во всяком случае, я думал, что это было забавно.

/* The License:
You (from this point on referred to as The You) are hereby 
granted by me (from this point on referred to as The Me) 
license to knock yourself silly with this template. 
By using this template The You implicitly accepts this 
license and pledges solemnly to never claim creative 
ownership of any graphics, code, concepts, eggs, bacon, ideas, 
colors, shapes, hypertext-transfer protocols or other conduits 
of the visual splendor thatis this template. 

The Me, in turn, pledges equally solemnly to be far too 
lazy to ever check up on you, so if you do manage to pull 
some chicks The Me won't have a cow. 
However The Me would be sorely disappointed if The You 
were to try and sell or distribute this work without 
acknowledging The Me. Seriously. The Me will come down on 
The You like a large quantitiy of hard and heavy objects 
that in large quantities may be harmful and possibly even 
lethal to The You; So don't even think about it, The Buster.
*/

Простой, но эффективный комментарий перед небезопасным взломом некоторого кода C ++

// yikes

Около 10 лет назад я работал над обработкой изображений, кадрами сканирующего микроскопа для обнаружения движения клеток. Я работал над очень сложным мероприятием и решил пойти выпить с друзьями. Вернувшись домой, я немного поработал, но не слишком много, потому что был пьян. На следующее утро после того, как я обнаружил 10-строчную полностью испорченную функцию со следующим комментарием (очевидно, написанным другим мной):

/* Ah ah ah! You'll never understand why this one works. */

Самым странным было то, что он даже работал.

Я использовал это несколько раз, когда делал какое-то неочевидное упрощение математической формулы, которое мне не хотелось документировать:

//this formula is right, work out the math yourself if you don't believe me

Из одного из наших проектов.
Где-то в конце одного исходного файла.

/*@                                    /\  /\
 * @                                  /  \/  \                        ----- |   | ----      |---\ |    | /--\  --- |   |  ---- /--\ /--\
 *  @                                /        --                        |   |   | |         |   / |    | |      |  |\  |  |    |    |
 *   \---\                          /           \                       |   |---| ----      |--/  |    |  \     |  | \ |  ----  \    \
 *    |   \------------------------/       /-\    \                     |   |   | |         |  \  |    |   -\   |  |  \|  |      -\   -\
 *    |                                    \-/     \                    |   |   | ----      |---/  \--/  \--/  --- |   \  ---- \--/ \--/
 *     \                                             ------O
 *      \                                                 /                 --- |   | ----  /--\        |--\   /--\   /--\
 *       |    |                    |    |                /                   |  |\  | |    |    |       |   | |    | |
 *       |    |                    |    |-----    -------                    |  | \ | ---- |    |       |   | |    | | /-\
 *       |    |\                  /|    |     \  WWWWWW/                     |  |  \| |    |    |       |   | |    | |    |
 *       |    | \                / |    |      \-------                     --- |   \ |     \--/        |--/   \--/   \--/
 *       |    |  \--------------/  |    |
 *      /     |                   /     |
 *      \      \                  \      \
 *       \-----/                   \-----/
 */

//You are not expected to understand this

классический.

В инструкции GIGANTIC 800 line 'switch' где-то посередине:

// Joe is sorry

Через несколько сотен строк ...

// Harry is sorry too

Это настоящий код, который мне когда-то приходилось поддерживать. После попыток понять логику AstaSaysGooGoo и AstaSaysGaaGaa (где было объявлено и использовано гораздо больше astaTempVars) я был готов сдаться. Я наконец поднял глаза и увидел комментарий «@author», и все это начало обретать смысл.

/*

* @author Andrew Asta
*/
public class AstaClass{

    private String astaVar1;    
    private String astaVar2;    
    private String astaVar3;    
    private String astaVar4;    
    private String astaVar5;    
    private String astaVar6;    
    private String astaVar7;    
    private String astaVar8;    
    private String astaVar9;    
    private String astaVar10;   

    public void AstaSaysGetData(){
        //JDBC statement to populate astavars 1 through 10
        //...
        String astaSqlStatment = "Select astaCol1, astaCol2, astaCol3... From AstaTable Where...";
        //..
        //...
    }

    //Perform data manipulation on astavars...
    public void AstaSaysGaaGaa(){
          [removed for sake of brevity]
    }


    //Perform more data manipulation on astavars...
    public void AstaSaysGooGoO(){
        [removed for sake of brevity]
    }

    public void AstaSaysPersist(){      
        //JDBC statement to save astavars to DB 
        String astaSqlStatment = "Update AstaTable set astaCol1 = @astaVar1
                                                  , set astaCol2 = @astaVar2
                                                  , set astaCol3 = astaCol3... 
                                                  Where...";
    }
}

PS Я изменил настоящее имя авторов, чтобы не вмешиваться в какие-либо споры и т. Д.

Из исходного кода UNIX-версии веб-браузера Netscape, около 1997 года:

/* HP-UX sucks wet farts from dead pigeons' asses */

К сожалению, такие жемчужины были удалены до того, как Moz стал открытым исходным кодом ...

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

//**************************************
// Dear code maintainer:
//
// This source contains COM interfaces, not to be confused with interfaces 
// of any other sort, please do not just willy-nilly add additional methods 
// to these interfaces as they are truely immutable, unlike the interfaces 
// that other software vendors like Microsoft maintain.  IF you need to add 
// new functionality, then go thru the trouble of creating a NEW interface 
// and implement this functionality on only the objects you need.  
//
// While the money is good for fixing all of the problems caused by not 
// following the rules, I would rather work on things which actually have
// an impact on the future of the product rather than curse and yell 
// obsenities at the screen because someone didn't bother to understand the
// true meaning of IMMUTABLE.  
//**************************************

Там был старый код javascript, хотя и неплохо написанный. Затем была строка комментария

// and there is where the dragon lives

с последующим мероприятием 4 человека потратили день, чтобы понять, что он делает. Наконец мы поняли, что он даже не используется и ничего не делает.

-- Comment this later

Это была строка 2 процедуры PL / SQL из 4000+ строк. И единственный комментарий. Спустя 4 года после того, как эта процедура была разработана, потом так и не наступило ...

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

/*
    Description: The Total Perspective Vortex derives its picture of the
                 whole Universe  on the principle of extrapolated matter
                 analyses.

                 To  explain  -  since every piece of matter in the Universe
                 is in some way affected by every other piece of matter in
                 the  Universe,  it  is  in  theory possible to extrapolate
                 the whole of creation - every sun, every planet, their
                 orbits, their composition and their economic and social
                 history from, say, one small Macro.

                 The man who invented the Total Perspective Vortex did so
                 basically in order to annoy the IT department.

                 Steve Weet - for that was his name - was a dreamer, a
                 thinker, a speculative philosopher or, as some would have
                 it, a slacker.

                 And they would nag him incessantly about the utterly
                 inordinate amount of time he spent staring out into space,
                 or mulling over the mechanics of Chelsea FC, or doing
                 spectrographic analyses of macros.

                 "Have  some  sense  of  proportion!"  they would say,
                 sometimes as often as thirty-eight times in a single day.

                 And so he built the Total Perspective Vortex - just to show
                 them.

                 And into one end he plugged the whole of reality as
                 extrapolated  from one  macro, and into the other
                 end he plugged the IT department: so that when he turned it
                 on they saw in one instant the whole infinity of creation 
                 and theirselves in relation to it.

                 To  Steve Weet's horror, the shock completely annihilated '
                 their brains; but to his satisfaction he realized that he
                 had proved conclusively that if life is going to exist in a
                 Universe of this size, then the one thing it cannot afford
                 to have is a sense of proportion.

*/

catch (Ex as Exception)
{
     // oh crap, we should do something.
}

Нет ничего лучше пустого блока catch, чтобы заставить человека почувствовать, что код надежен ...

Чтобы защитить виновных, ценности были изменены

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

Мы добавили изображения, а остальное оставили в покое; другой разработчик решил, что было бы интересно отправлять ему электронные письма от его будущего себя (а-ля The Office), и сказал, что потребовалось почти две полных недели ежедневных писем, прежде чем вход в систему перестал работать.

'    ROFL:ROFL:LOL:ROFL:ROFL
'        ______/|\____
'  L    /          [] \
' LOL===_      ROFL    \_
'  L     \_______________]
'            I      I
'        /---------------/

'TODO: REMOVE MY INFO AND REPLACE WITH USER CREDENTIALS
'Private TEST_LoginName As String = "[email protected]"
'Private TEST_Password As String = "Humsal892"
'Private TEST_Server As String = "imap.secureserver.net"

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

Я вижу это много:

// TODO make this work

Заявление об очевидном?

/** Logger */
private Logger logger = Logger.getLogger();

Несколько лет назад, когда я писал Perl, я добавил эти комментарии вверху и внизу:

# <magic type="voodoo">

...

# </magic>

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

Из проекта кода Google:

# This job would be great if it wasn't for the fucking customers.

when :orientation
## Avoid matching gay people with straight people - they hate it, they do, they really do.
query_parameter = "(users.orientation = 'Bi' OR (users.orientation = 'Straight' AND users.gender IN ('#{user.opposite_genders.join('\',\'')}')) OR (users.orientation = 'Gay' AND users.gender IN ('#{user.same_genders.join('\',\'')}')))"

С сайта знакомств ...

В: «Какой самый лучший комментарий в исходном коде вы когда-либо встречали?»

A: Легко - тот, который помог мне решить любую проблему, которая у меня была в то время, а их много!

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

//        .==.        .==.          
//       //`^\\      //^`\\         
//      // ^ ^\(\__/)/^ ^^\\        
//     //^ ^^ ^/6  6\ ^^ ^ \\       
//    //^ ^^ ^/( .. )\^ ^ ^ \\      
//   // ^^ ^/\| v""v |/\^ ^ ^\\     
//  // ^^/\/ /  `~~`  \ \/\^ ^\\    
//  -----------------------------
/// HERE BE DRAGONS

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

//  If you delete the credits, I will fucking kill you.

найдено в модуле joomla.

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

...

// get the units from the form 
int numUnits = Integer.parseInt(request.getParameter("num_pieces")); // this break at random times

//price 
float price = Float.parseFloat(request.getParameter("price")); // same as above

// Under certain conditions the following code blows up. I don't know those conditions.
float pricePerUnit = price / (float)numUnits;

...

Один мой старый начальник всегда говорил о том, как нам нужно использовать наши собственные продукты для внутренних целей, например: «Ешьте наш собственный корм для собак ...»

Много лет спустя я обнаружил, что в каком-то источнике, который сделал временный коллега, каждая функция, к которой он прикоснулся, помечена тегами:

/* NOT FIT FOR HUMAN CONSUMPTION */

Классический ASP:

'Is it worth it, let me work it'
'I put my thing down, flip it and reverse it'
'Ti esrever dna ti pilf, nwod gniht ym tup I'

NextIP = StrReverse(UserRecordset.Fields.Item(0))

Много лет назад я столкнулся с этим:

/***************************************************************************/
/*  deep wizardry. do not touch.                                           */
/*                                                                         */
/*  no seriously.  XXXXXX I'm looking at you. If you screw with this again */
/*  I will kill you with my swingline stapler.                             */
/*                                                                         */
/* ...                                                                     */

А затем перешел к описанию особенно сложного алгоритма.

// (c) 2000 Applied Magic, Inc.
// Unauthorized use punishable by torture, mutilation, and vivisection.

Ах, я всегда любил этого ...

//open lid


//take sh!t


//close lid

Комментарии для открытия файла, дампа данных, закрытия файла ...

Исходный код продукции:

// Remove this if you wanna be fired

Некоторое время назад наткнулся на:

raise InvalidChild() # e.g. no legs

Это гротеск, поскольку "inwalida" в переводе с польского означает человек с ограниченными возможностями. глупый я :)

Лучший на данный момент:

"This code makes baby Jesus very sad!". 

Он ссылался на инициализацию String следующим образом:

String blankSpaces="                              "+ //100 whitespaces
                   "                              "+ //200 Whitespaces
                   ...
                   "                                        " //100 whitespaces

Ну вы поняли.

Я говорю подопечному выполнить хотя бы НЕКОТОРЫЕ исключения. Это то, что я получаю взамен при каждом вызове db ....

Catch (Exception e) {
    //eat it
}

Честное слово перед Богом:

// This is crap code but it's 3 a.m. and I need to get this working.

Когда я работал на Reuters, в одном из наших обработчиков каналов был комментарий, который заставил некоторых людей подумать, что Всевышний нам помогает ...

// Jesus told me to skip to the end of the message here

Позже мы узнали, что был контакт из Латинской Америки по имени Иисус (HeyZus).

Самый любимый комментарий, который я когда-либо писал:

//the XML returned from this request is *mind-bogglingly* bad. Terrifyingly bad.
//a completed batch looks like this:
//<Batch>batchid=363777811 status=Done dateandtime=09/18/2007 09:53:10 PDT activateditems=335 numberofwarnings=0 itemsnotacivated=17 </Batch>
//and an incomplete batch like:
//<Batch>batchid=363778361 status=In Progress </Batch>
//so we'll just parse each item as a regex. Thanks Amazon.

И да, Amazon действительно возвращает XML вот так.

//  Hey, your shoe's untied!

За ним следует какой-то сомнительный код, и в этом коде

//  Keep looking!  I think it was the other shoe!

Ну наконец то,

//  How strange -- I must be seeing things.  Anyhow, I'm going to go take a shower, now...

В хорошо известном коммерческом приложении для работы с электронными таблицами DOS:

/* This comment was just added in order to check-in a file that was last 
checked in by [Insert Programmer FirstName] "Back-to-the-Future" [Insert 
Programmer LastName]. While testing for year 2000 problems, he accidentally 
checked-in this file while his machine clock was set forward to the year 2000. 
This meant that the source code was always newer than the object file and 
compiled every time the code was built. I'm checking this file in again to 
fix that. */

Мне больше всего нравится покойный великий Поль Дилашия:

// Author: If this code works, it was written by Paul DiLascia. If not then I don't know who wrote it.

Все ошибки добавлены Дэвидом С. Миллером

В игре, где на этот объект можно наступить, или:

stepOff(); //bitch

/ * А теперь, чтобы все это выглядело наполовину прилично в отсталом сводном брате семейства браузеров, Internet Fucking Explorer * /

// This is a walkaround for bug #7812

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

Мне эта очень понравилась. Я думаю, что «обходной путь» - почти лучший термин, чем «обходной путь».

Журнал изменений, который я заметил в устаревшем коде

17.05.99 Д ДЖОНС КОММЕНТАРИЙ К КОДУ BLOODY AUZIES (19.02.99)

17.05.99 K ROBINSON BLOODY TEXAN НЕ МОЖЕТ ПРАВИЛЬНО НАПИСАТЬ AUSSIE (КОД НЕ МЕНЯЕТСЯ - ПРОСТО КОММЕНТАРИЙ)

Использование точки с запятой в VB.NET

TextBox2.Visible = True';
For Each row In data.Tables(0).Rows
    If row("Customers.Id").ToString <> customerId Then
        customerId = row("Customers.ID").ToString';
        name = "Customer Name: " & row("Name").ToString & CrLf';
        address = "Address: " & row("Address").ToString & CrLf & CrLf';
        TextBox2.Text += name & address ';s
    End If';
Next';

Еще в начале восьмидесятых я наткнулся на это на ассемблере (цитата по тусклой памяти):

I don't understand how the following bit works, but it worked in the program I stole it from.

Немецкий комментарий в исходном коде, переведенный машиной или очень уставшим человеком + Google

; Rechnen ja ; have faith in yes

Я предполагаю, что оригинал означал «здесь считать правдой» ... но с тех пор я воспринимаю это как мантру своей жизни.

Немного из ядра Linux:

/* Sun, you just can't beat me, you just can't.  Stop trying,
* give up.  I'm serious, I am going to kick the living shit
* out of you, game over, lights out.
*/

-

/* 2,191 lines of complete and utter shit coming up... */

-

#if 0 /* XXX No fucking way dude... */

Из исходного кода 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.

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

Где-то из facebook api.

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

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

Этот я нашел в пакете "twisted" для 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))

Из классической программы от usenet:

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

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

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

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

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

// HERE

Я только что проверил, комментарий все еще есть в этом файле :)

Этот из 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.

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

return null; //Not really null

Мне всегда нравилась эта фраза.

Выставка:

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
);

// This will save us ~0.5 sec for every user and please the machine spirits.

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

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

//This was clearly written under duress

// Hard to explain

В конце концов, он тоже сломался. Неудивительно, что это было сложно объяснить

// 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 раз этого комментария ...

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

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

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

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

' RIP LVB

(возьми?)

// this error could never happen

А затем - звонок клиента о том, что он видит сообщение об ошибке, что "эта ошибка не может произойти никогда".

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

  //  IMPLEMENTATION GOES HERE

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

Но кода нет;)

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

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

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

Конечно, я получил его обратно с большой синей буквой «А» спереди и без галочки.

  rescue
    # silently, we fail
    # many validations fade
    # like tear drops in rain
  end

Это лишь один из многих ...

Нашел это в make-файле

# ===== Never edit below this line. Ever. Or I'll kick your ass. ====

Мой любимый комментарий всех времен использовал мой друг-гей. Ему нравилось отмечать все свои комментарии TODO в VB.NET как

'TODO: Matt Damon

Иногда предоставлялась дополнительная информация, но не обычно.

Фактически это было сделано мной, когда я реализовывал прототип, превращенный в настоящий код:

// Abandon all hope you who needs to debug this

Да, кто-то умнее меня впоследствии реорганизовал код (у него должен был быть хороший финал).

«Этого никогда не будет».

Знаменитые последние слова мой друг ...

Комментарии по Linux

Хороших тут куча ...

Это все комментарии в linux

http://lwn.net/1998/1015/a/f-word.html

Мои любимые:

./arch/sparc/kernel/ptrace.c
/* Fuck me gently with a chainsaw... */

./drivers/scsi/qlogicpti.h
/* Am I fucking pedantic or what? */

Не комментарии к коду, а комментарии SVN к одному и тому же файлу:

Первая фиксация (после десятков других после получения результатов от тестировщиков):

Squashed some IPR mod bugs. The were big and juicy ones, too.

2-я фиксация:

Squashed some more mod bugs. Those are some nasty bugs, them mod bugs...

3rd:

Squashed some more mod bugs. They are like cockroaches: they'll live through a nuclear war.

4th:

Squashed some more John bugs. They too are like cockroaches: they appear anywhere John goes. Wait. That doesn't sound right.

И 5-й:

Same John bug. It didn't die, just played 'possum.

Да, надоел "Исправленный баг".

Мне нравятся некоторые комментарии в GNU binutils. Это от BFD som.c:

/* You'll never believe all this is necessary to handle relocations
   for function calls.  Having to compute and pack the argument
   relocation bits is the real nightmare.

   If you're interested in how this works, just forget it.  You really
   do not want to know about this braindamage.  */

Это тоже:

/* Don't ask about these magic sequences.  I took them straight
   from gas-1.36 which took them from the a.out man page.  */

...

/* Keep track of exactly where we are within a particular
   space.  This is necessary as the braindamaged HPUX
   loader will create holes between subspaces *and*
   subspace alignments are *NOT* preserved.  What a crock.  */

Еще один:

/* We will NOT put a fucking timestamp in the header here. Every
   time you put it back, I will come in and take it out again. ... */

От газа:

/* Yes this is ugly (storing the broken_word pointer
   in the symbol slot).  Still, this whole chunk of
   code is ugly, and I don't feel like doing anything
   about it.  Think of it as stubbornness in action.  */

Я думаю, это стало вирусным, я обнаружил следующее в демоне (Linux), который не позволяет убийце OOM выбрать его:

/*
 * Don't OOM me, bro!
 */

Это было сразу после mlockall (), чтобы предотвратить подкачку процесса, прокомментировал:

/*
 * Don't swap me, bro!
 */

/* FIXME This must absolutely be removed before 4.0.7 release
 * TODO really remove this */

с тех пор мы выпустили версии 4.0.7, 4.0.8, 4.0.9 и 4.1 ...

Однажды я работал над проектом, где нашел такой комментарий:

// Cabbage fart?

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

Что ж, вот один, который я только что совершил:

/* Every time I re-visit this function, I feel like
 * I need to take a shower.
 *
 * Don't get too used to this function, its days are
 * numbered.
 */

Кто-то может запустить что-то вроде greatcodecomments.com и заработать немного денег. Однако этот человек не я.

Мой любимый (должен признать, что использовал много раз):

// Yes...I know this is repulsive and stupid.
// But <%CompanyOwnerOrManagerToken%>, not knowing a thing about code,
// demanded I do it anyways. SO, go crap on their desk, not mine.
// K THX BYE 

/* Here I sit, Joe broken hearted, came to do some sh*t, but only just started. */

Что касается тяжелой проверки ввода регулярных выражений.

В середине файла JScript из нескольких тысяч строк после совершенно произвольной строки ...

// The world is a happy place.

В заголовке файла XSLT:

DON'T TOUCH THIS SCRIPT -> XSLT is like arcane, black magic

Найдено в JUnit API:

/**
 * ...as the moon sets over the early morning Merlin, Oregon
 * mountains, our intrepid adventurers type...
 */
public Test createTest(Class theClass, String name) {
    ...
}

Точно не помню, но идея была примерно такая:

Person p = new Person("John", "Doe", "male");
Collection women = new ArrayList();
women.insert(p.getTail());

Это грязный код;)

// Whoever put this here is an idiot...this doesn't work at all !

Но код все еще там ...

Видно в исходном коде компьютерной игры LucasArts «Эйдолон» (которая сама по себе была странной и дурацкой) ...

// He's dead, Jim!

От парня, который явно наблюдал за Монти Пайтоном:

> // And now, for something completely
> // different:

class theLarch {

Только что добавил это сегодня:

// Hardcoded this for time sake ... will make andrew fix later :)

Этот комментарий взят из старого проекта, который мне пришлось отлаживать:

//Haleluya i can go home!

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

        /************************************************************
        *                                                           *
        *  .=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-.       *
        *   |                     ______                     |      *
        *   |                  .-"      "-.                  |      *
        *   |                 /            \                 |      *
        *   |     _          |              |          _     |      *
        *   |    ( \         |,  .-.  .-.  ,|         / )    |      *
        *   |     > "=._     | )(__/  \__)( |     _.=" <     |      *
        *   |    (_/"=._"=._ |/     /\     \| _.="_.="\_)    |      *
        *   |           "=._"(_     ^^     _)"_.="           |      *
        *   |               "=\__|IIIIII|__/="               |      *
        *   |              _.="| \IIIIII/ |"=._              |      *
        *   |    _     _.="_.="\          /"=._"=._     _    |      *
        *   |   ( \_.="_.="     `--------`     "=._"=._/ )   |      *
        *   |    > _.="                            "=._ <    |      *
        *   |   (_/                                    \_)   |      *
        *   |                                                |      *
        *   '-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-='      *
        *                                                           *
        *      LASCIATE OGNI SPERANZA, VOI CH'ENTRATE               *
        *************************************************************/

Из исходного кода UNIX версии 6, около 1975 года:

/* You are not expected to understand this. */

// Fuck.

Это и ...

// This code worked before, but my cat decided to take a trip across my keyboard...

'Do not optimize these next two lines. Compiler bugs lurk.

И они это сделали. Сжатие переменной в выражение во второй строке привело к прыжку в середину кучи и попытке выполнить данные.

THIS PROGRAM HAS CODE THAT DOES NOT MEET STANDARDS      

Этот комментарий есть почти в каждой программе, которая у нас есть ....

# absolutely foul heuristic code.
# ..it's dirty, but you want it.

и:

# VERY USEFUL DEBUGGING AID, for when the above all goes pearshaped:

Не комментарий, а атрибут

[ThereBeDragons]

И один я видел в реализации IHttpHandler

//What is this?
public bool IsReusable
{
    get{return false;}
}

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

// These were orginally up and down. When it was clear the names were
// inapplicable, they were renamed to retain the joke.
// Sorry if you were hoping for useful variable names.
quantum strange, charm;

При отладке чужого JavaScript я увидел следующий комментарий:

// Notice: I feel so dirty doing this, but it's the only way to make it cross browser.

Но, читая пост Скотта Хансельмена, я наткнулся на следующую цитату, которая очень хорошо сочетается с комментариями, которые я нашел внутри кода:

Every line of code you write that you feel gross about will ultimately come back to haunt you. Therefore, avoid writing code that makes you feel dirty.

Это забавно :)

// Bad Christian, No cookie

Cookie в этом контексте не относится к cookie браузера.

Это мой самый любимый комментарий.

/// I intend to do this as shittily as possible because there are many better products that will totally blow this out of the water
/// and we don't have them so whatever

Позже в этом файле мы повеселимся, например,

/// sidestep a bug in WCF (that we can't send types across)
/// or, depending on how you look at, this issue is a Feature

И снова позже

if( where == null)//be nice

В крупном инвестиционном банке, который требовал, чтобы все сбои приложений регистрировались и комментировались, я видел

Without a crash 

Or mighty bang 

The sync disk 

Did it's process hang

Я только что наткнулся на это в очень простой тестовой программе на C ++ для класса в колледже.

Я комментировал курс.

В деструкторе ...

// Choose! Choose the form of the Destructor!
// The choice is made! The Traveler has come!

Я обнаружил этот драгоценный камень при просмотре HTML-источника более ранней версии итерация сайта ТВНЗ (из строки 571, если вы подыгрываете дома):

<!-- Hopfully we can do this otherwise the nav is going to be pretty plain and Hong will go postal. -->

// TODO: Drive an ashen stake through the foul heart of this function.

И это была грязная функция. Мне по сей день снятся кошмары об этом.

Ну, это мои, так что WTF - это я, как сказал CodingHorror:

//#region Code for weird cases - do you really want to know?

Однажды я оставил такой комментарий в каком-то ASP:

' Commented out following code, don't delete for when [CustomerName] changes his mind

Так получилось, что [CustomerName] не передумал, но он ДЕЙСТВИТЕЛЬНО имел доступ к веб-серверу, и он ДЕЙСТВИТЕЛЬНО нашел эту строку ...

Я нашел это в поиске кода Google

    // Constructs a tuple with 2 elements (fucking idiot, use std::pair instead!)
    template <typename T0,typename T1>
    inline tuple <T0,T1> make_tuple (const T0& t0,
            const T1& t1) {
            tuple <T0,T1> t;
            t.get<0>() = t0;
            t.get<1>() = t1;
            return t;
    }

// TODO: not this

Написано коллегой над запросом, отчаянно нуждающимся в оптимизации. В его защиту, мы все работали по 70 часов в неделю в течение нескольких месяцев на тот момент ...

// This part is more difficult

Вверху метода.

Это было около 5 строк.

И не очень сложно.

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

Во всем приложении.

Забавная опечатка, странно подходящая:

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

Не совсем комментарий:

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

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

В LKM:

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

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

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

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

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

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

Еще больше удовольствия с поиском кода Google. ..

Я видел этот код в функции FULL явных странных приведений:

// 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. "

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

Перекомпилируем FreeTextBox3 впервые в нашем приложении, потому что нам нужна поддержка IE8 ... И посмотрите, что я нашел:

// 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

Я обнаружил это при повторном использовании класса 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;
}

Некоторые из очень немногих комментариев в более чем 5000 строк кода в одном файле
У меня действительно есть спор с кодировщиком, который защищал свой стиль кодирования ...
Без комментариев!
И не было никаких комментариев; - ) (или очень мало)
К сожалению, это производственный код.

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 A" в шапке, нет.

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

а что 720?

Изучая уровень аппаратной абстракции, работая на одного финского производителя оборудования для мобильных сетей, я обнаружил более 100 случаев финского слова «пуукко».

Пуукко - это универсальный нож, который есть у каждого финна в ящике для инструментов или дома. Его используют для всего, от чистки картофеля до ремонта компьютеров (мои наблюдения). Я считаю, что в этом контексте это финский эквивалент слова «взломать».

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

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

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

Подонок.

Через некоторое время мне это наскучило ...

// 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]

Через несколько часов после того, как я показал другу этот пост из Coding Horror, я увидел это прокомментируйте его код:

// Мистер Валдез - жестокий психопат. Не зли его.

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

// zzzzZZZZzzzz....

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

// 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.

Из класса модульного тестирования на 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

Это было для настраиваемого DHCP-сервера, который мы использовали в общежитиях университета для помещения компьютеров в пулы «чистых» или «грязных» IP-адресов в зависимости от того, зарегистрированы / установлены ли они исправления и антивирус:

public boolean getDirty (String MAC) // not as fun as it sounds

Вся эта функция довольно хороша (из драйвера Linux sunhme.c для сетевой карты, получившей от Sun прозвище Happy Meal. Потому что карта, которая была до этого, была «Big MAC». Поняли? Поняли?)

static void happy_meal_tcvr_write(struct happy_meal *hp,
                              void __iomem *tregs, int reg,
                              unsigned short value)
{
    int tries = TCVR_WRITE_TRIES;

    ASD(("happy_meal_tcvr_write: reg=0x%02x value=%04x\n", reg, value));

    /* Welcome to Sun Microsystems, can I take your order please? */
    if (!(hp->happy_flags & HFLAG_FENABLE)) {
            happy_meal_bb_write(hp, tregs, reg, value);
            return;
    }

    /* Would you like fries with that? */
    hme_write32(hp, tregs + TCVR_FRAME,
                (FRAME_WRITE | (hp->paddr << 23) |
                 ((reg & 0xff) << 18) | (value & 0xffff)));
    while (!(hme_read32(hp, tregs + TCVR_FRAME) & 0x10000) && --tries)
            udelay(20);

    /* Anything else? */
    if (!tries)
            printk(KERN_ERR "happy meal: Aieee, transceiver MIF write bolixed\n");

    /* Fifty-two cents is your change, have a nice day. */

}

// TODO: what the hell is this all about?

А затем закомментированный код.

Это было обнаружено в нашем коде в работе ранее сегодня. Я не уверен, смеяться мне или плакать ...

Ctrl + A, перезаписать

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

Я когда-то работал над исходным кодом Windows 3.0. (Нет, я спешу добавить, как сотрудник Microsoft!) Там я наткнулся на загрузчик файлов, который возвращался несколько раз, и у меня был один пример неприятного каламбура (просто чтобы показать, насколько умным был автор).

Этот беспорядок реентерабельного кода был выполнен с помощью инструкции jmp сборки Intel (в середине кода C), которая перешла на метку "we_are_not_in_kansas_any_more_toto".

-- Change Log:  Not needed. The code is perfect 'cause I wrote it.
-- If you change it, it will break.

Я просматриваю некоторые комментарии к коду, чтобы убедиться, что они имеют смысл, и увидел скромную строку выше.

//Iterate by one
$i++;

К сожалению, это было мое, во время моей фазы «Все должны комментировать».

Работая над некоторыми веб-сайтами, я обнаружил следующее при запуске встроенного JS:

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

УЖАСНЫЙ патч для декодирования (перевод на итальянский язык):

/**
*@return the value 
*@param key: the id of the list of instruments
*@PS this function is a violation of all the laws of the 
*software engineering, 
*commons sense, highway code 
*and ONU decision about the coding.
That sh*t...
*/

Только что нашел это в нашем PHP-коде.

$s=2; // chicken and bacon wrap for lunch

Насколько полезно, к счастью, $ s не требует пояснений

удалось вставить этот плохой каламбур в наш код

for (bo_thans = 0 ; bo_thans < MAX ; bo_thans++)
{
    if(rs == thing[bo_thans])
    {
       found = true;
    }
}

if(!found)
{
   /* Failed to find rs with bo_thans */
   ...
}