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

360
задан 14 revs, 11 users 61% 17 September 2011 в 14:54
поделиться

518 ответов

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

/**
* For the brave souls who get this far: You are the chosen ones,
* the valiant knights of programming who toil away, without rest,
* fixing our most awful code. To you, true saviors, kings of men,
* I say this: never gonna give you up, never gonna let you down,
* never gonna run around and desert you. Never gonna make you cry,
* never gonna say goodbye. Never gonna tell a lie and hurt you.
*/

Я СОЖАЛЕЮ!!!! я просто не мог помочь мне.....!

И другой, который я признаю, что на самом деле не выпустил на волю, даже при том, что я очень , заставил делать так в одном из моих менее интуитивных классов:

// 
// Dear maintainer:
// 
// Once you are done trying to 'optimize' this routine,
// and have realized what a terrible mistake that was,
// please increment the following counter as a warning
// to the next guy:
// 
// total_hours_wasted_here = 42
// 
1463
ответ дан 21 revs, 20 users 72% 23 November 2019 в 00:15
поделиться
//This code sucks, you know it and I know it.  
//Move on and call me an idiot later.
352
ответ дан 3 revs, 3 users 40% 23 November 2019 в 00:15
поделиться

в полностью непрокомментированном методе строки 2000 года

{ 
  { 
    while (.. ){ 
      if (..){
          }
      for (.. ){ 
          }
         .... (just putting in the control flow here, imagine another few hundred ifs)
      if(..)   {
            if(..)     {
                   if(..)   {
                ...
                (another few hundred brackets)
                       }
                  }
         } //endif

(я на самом деле захватил все скобки однажды только, чтобы видеть, как плохо это было, и, без форматирования, получил это:

{{{{}}{}{}{}{}}{{}{{}{}{}{}{}{}{{}{}}{}{}{{}{}{}{}{}{}{}{}{}{}{}{{}}}{{}{{}}{{{}}}{{}{}{}{}{}{}{}{{}}{}{{{}}{}{{}{}}{{{}}{}{}{}{}}{{}}}{}{{}{}{}{{}{{}}{}}{{}}}{{}}{{}}{{}}{}{{}}{{}}{{}}{{}{}{}}{}{}{{{}}{{}}}{}{}{}{}}{{{}{{}{}{}{{}{}{}{}{}{}}{}}{{}}{{}{}}}{{}}{{}}}{{}}{{}}{}{}{}{}{{}}{{}{}{}{}}}}{}{}}{{}{{{}{}{}{}}}}{{}{{{}}}}{{}{{{}{{}}{}{{}}{}{{}{}}{{}}{}{{}}}{{}}}}{{}{}{}{}{}{{{}    {{{{}}{}{}{}{}}{{}{{}{}{}{}{}{}{{}{}}{}{}{{}{}{}{}{}{}{}{}{}{}{}{{}}}{{}{{}}{{{}}}{{}{}{}{}{}{}{}{{}}{}{{{}}{}{{}{}}{{{}}{}{}{}{}}{{}}}{}{{}{}{}{{}{{}}{}}{{}}}{{}}{{}}{{}}{}{{}}{{}}{{}}{{}{}{}}{}{}{{{}}{{}}}{}{}{}{}}{{{}{{}{}{}{{}{}{}{}{}{}}{}}{{}}{{}{}}}{{}}{{}}}{{}}{{}}{}{}{}{}{{}}{{}{}{}{}}}}{}{}}{{}{{{}{}{}{}}}}{{}{{{}}}}{{}{{{}{{}}{}{{}}{}{{}{}}{{}}{}{{}}}{{}}}}{{}{}{}{}{}{{{}{}{{}}{}}}{}}{{}}{{}{}}{{}{{}{{}}}}{{{}{{{}}}}}{{{{{}}}}}{}{}{}{{{{}}}{}{}}{{}{{}}}}{}{{}}{}}}{}}{{}}{{}{}}{{}{{}{{}}}}{{{}{{{}}}}}{{{{{}}}}}{}{}{}{{{{}}}{}{}}{{}{{}}}}

endif обнаружился вокруг строки 800)

353
ответ дан 4 revs, 3 users 96% 23 November 2019 в 00:15
поделиться
long long ago; /* in a galaxy far far away */ 
354
ответ дан 2 revs, 2 users 67% 23 November 2019 в 00:15
поделиться

О середине xslt

<!-- Here be dragons  -->
на 30 страниц
362
ответ дан 2 revs, 2 users 80% 23 November 2019 в 00:15
поделиться
const int TEN=10; // As if the value of 10 will fluctuate... 
387
ответ дан 3 revs, 2 users 75% 23 November 2019 в 00:15
поделиться
try {

} finally { // should never happen 

}
429
ответ дан 2 revs, 2 users 89% 23 November 2019 в 00:15
поделиться
/*
 * You may think you know what the following code does.
 * But you dont. Trust me.
 * Fiddle with it, and youll spend many a sleepless
 * night cursing the moment you thought youd be clever
 * enough to "optimize" the code below.
 * Now close this file and go play with something else.
 */ 
457
ответ дан 2 revs, 2 users 93% 23 November 2019 в 00:15
поделиться
/**
 * Always returns true.
 */
public boolean isAvailable() {
    return false;
}

Никогда не полагаются на комментарий...

496
ответ дан 2 revs, 2 users 93% 23 November 2019 в 00:15
поделиться
Catch (Exception e) {
 //who cares?
} 
508
ответ дан 3 revs, 3 users 50% 23 November 2019 в 00:15
поделиться
long john; // silver
525
ответ дан Sean 23 November 2019 в 00:15
поделиться

Это говорит красноречивее всяких слов о нашей профессии, что, когда спрошено о "лучшем комментарии", все мы отвечаем худшими комментариями, которые мы можем найти...

542
ответ дан 3 revs, 3 users 50% 23 November 2019 в 00:15
поделиться
// If this comment is removed the program will blow up 
324
ответ дан 2 revs, 2 users 67% 23 November 2019 в 00:15
поделиться
return 1; # returns 1
636
ответ дан Lateral 23 November 2019 в 00:15
поделиться
// I'm sorry.
640
ответ дан 2 revs, 2 users 67% 23 November 2019 в 00:15
поделиться
// Magic. Do not touch.
719
ответ дан Jason Sundram 23 November 2019 в 00:15
поделиться
// drunk, fix later

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

727
ответ дан 3 revs, 2 users 83% 23 November 2019 в 00:15
поделиться
//Code sanitized to protect the foolish.
using System;
using System.Collections.Generic;
using System.Text;
using System.Reflection;
using System.Web.UI;

namespace Mobile.Web.Control
{
    /// <summary>
    /// Class used to work around Richard being a fucking idiot
    /// </summary>
    /// <remarks>
    /// The point of this is to work around his poor design so that paging will 
    /// work on a mobile control. The main problem is the BindCompany() method, 
    /// which he hoped would be able to do everything. I hope he dies.
    /// </remarks>
    public abstract class RichardIsAFuckingIdiotControl : MobileBaseControl, ICompanyProfileControl
    {
        protected abstract Pager Pager { get; }

        public void BindCompany(int companyId) { }

        public RichardIsAFuckingIdiotControl()
        {
            MakeSureNobodyAccidentallyGetsBittenByRichardsStupidity();
        }

        private void MakeSureNobodyAccidentallyGetsBittenByRichardsStupidity()
        {
            // Make sure nobody is actually using that fucking bindcompany method
            MethodInfo m = this.GetType().GetMethod("BindCompany", BindingFlags.DeclaredOnly | 
                BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic);
            if (m != null)
            {
                throw new RichardIsAFuckingIdiotException("No!! Don't use the fucking BindCompany method!!!");
            }
            // P.S. this method is a joke ... the rest of the class is fucking serious
        }

        /// <summary>
        /// This returns true if this control is supposed to be doing anything
        /// at all for this request. Richard thought it was a good idea to load
        /// the entire website during every request and have things turn themselves
        /// off. He also thought bandanas and aviator sunglasses were "fuckin' 
        /// gnarly, dude."
        /// </summary>
        protected bool IsThisTheRightPageImNotSureBecauseRichardIsDumb()
        {
            return Request.QueryString["Section"] == this.MenuItemKey;
        }

        protected override void OnLoad(EventArgs e)
        {
            if (IsThisTheRightPageImNotSureBecauseRichardIsDumb())
            {
                Page.LoadComplete += new EventHandler(Page_LoadComplete);
                Pager.RowCount = GetRowCountBecauseRichardIsDumb();
            }
            base.OnLoad(e);
        }

        protected abstract int GetRowCountBecauseRichardIsDumb();
        protected abstract void BindDataBecauseRichardIsDumb();

        void Page_LoadComplete(object sender, EventArgs e)
        {
            BindDataBecauseRichardIsDumb();
        }

        // the rest of his reduh-ndant interface members
        public abstract string MenuItemName { get; set; }
        public abstract string MenuItemKey { get; set; }
        public abstract bool IsCapable(CapabilityCheck checker, int companyId);
        public abstract bool ShowInMenu { get; }
        public virtual Control CreateHeaderControl()
        {
            return null;
        }
    }
}

Обновление: у исходного автора кода есть outed самого , таким образом, я должен дать кредит, где это должно. Dan McKinley покинул компанию, которой я был с тем, вскоре после того, как я запустил, и он говорит больше о коде, объясняя некоторый фон и еще некоторых "WTF's", который записал 'Richard'.

911
ответ дан 2 revs 23 November 2019 в 00:15
поделиться
// I dedicate all this code, all my work, to my wife, Darlene, who will 
// have to support me and our three children and the dog once it gets 
// released into the public.
930
ответ дан sharkin 23 November 2019 в 00:15
поделиться
// sometimes I believe compiler ignores all my comments
946
ответ дан Sergey Kornilov 23 November 2019 в 00:15
поделиться
stop(); // Hammertime!
1049
ответ дан Tuoski 23 November 2019 в 00:15
поделиться
Exception up = new Exception("Something is really wrong.");
throw up;  //ha ha
1056
ответ дан スーパーファミコン 23 November 2019 в 00:15
поделиться
//When I wrote this, only God and I understood what I was doing
//Now, God only knows
1052
ответ дан johnc 23 November 2019 в 00:15
поделиться
/* This is O(scary), but seems quick enough in practice. */ 

сопровождаемый четыре вложил для циклов

591
ответ дан 2 revs, 2 users 80% 23 November 2019 в 00:15
поделиться

This seems to stop morons from messing my code...

// Autogenerated, do not edit. All changes will be undone.
1031
ответ дан 3 revs, 3 users 50% 23 November 2019 в 00:15
поделиться
// Replaces with spaces the braces in cases where braces in places cause stasis 
   $str = str_replace(array("\{","\}")," ",$str);
589
ответ дан 23 November 2019 в 00:15
поделиться

#define TRUE FALSE // Счастливые отладочные присоски

701
ответ дан 23 November 2019 в 00:15
поделиться
    #Christmas tree initializer  
    toConnect = []  
    toRead =   [  ]  
    toWrite = [    ]   
    primes = [      ]  
    responses = {}  
    remaining = {}  
364
ответ дан 23 November 2019 в 00:15
поделиться

От: https://github.com/zepouet/Xee-xCode-4.5/blob/master/XeePhotoshopLoader.m#L108

// 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.
412
ответ дан 23 November 2019 в 00:15
поделиться
// somedev1 -  6/7/02 Adding temporary tracking of Login screen
// somedev2 -  5/22/07 Temporary my ass
826
ответ дан 23 November 2019 в 00:15
поделиться
Другие вопросы по тегам:

Похожие вопросы: