Мы все застряли внутри, так что вы можете развлечься, прочитав это!
Комментирование кода! Некоторые люди говорят, что это уродливо, некоторые говорят, что это стандарт и хорошая практика.
«Код никогда не лжет, иногда лгут комментарии» - Рон Джеффрис
Что ж, эта статья покажет вам, как комментирование кода тоже может быть бесполезным. Я перечислил некоторые бесполезные комментарии к коду, с которыми люди сталкивались в производственном коде.
Примечание: эта статья является продолжением 32+ забавных комментариев кода, которые люди написали на самом деле.
TL; DR Здесь серьезно! Прочтите это просто для удовольствия!
/*Added because someone asked me to add it*/// Increase i by one i++;// Times New Roman? What was wrong with the old Romans?// Do not remove this comment else compilation will fail./** * @author SomeUserWhoShouldKnowBetter * * To change this generated comment edit the template variable "typecomment": * Window>Preferences>Java>Templates. * To enable and disable the creation of type comments go to * Window>Preferences>Java>Code Generation. */// Steve did not send attribute so happy creativity // lets recreate it using available information // this logic should nod be here and I am waiting impatiently to //throw it away// TODO: DAN to fix this. Not Wes. No sir. Not Wes./* The Knuth books are not in the office only for show; they help make loops 30% faster and 20% as readable. */ //The truth is not out there. It is here #define TRUE (1==1) #define FALSE (!TRUE) // Had to do this because DB is in Abbie Normal Form // Times New Roman? What was wrong with the old Romans?#include <stdio.h> //why isn't this working!//???// return return;$i = 0; //set i to 0 $i++; //use sneaky trick to add 1 to i! if ($i==$j) { // I made sure to use == rather than = here to avoid a // bug// Undocumentedprivate //PRIVATE means PRIVATE so no comments for you function LoadIt(IntID: Integer): Integer;// Return value does not matter return 0;try { ... } catch { // TODO: something catchy }// do nothing// TODO: DAN to fix this. Not Wes. No sir. Not Wes.//I know that this is very ugly, but I am tired and in a hurry. //You would do the same if you were me... //... //[A piece of nasty code here]// Magic menu.Visible = False menu.Visible = True// My class! Class myclass { //Default constructor public myClass() { ... } }// secret sauce// remember to comment codetry { ...some code... } catch { // Just don't crash, it wasn't that important anyway. }if(some_condition){ do_stuff(); } else{ //An error occurred! }// TODO: Documentation.// This method takes two integer values and adds them together via the built-in // .NET functionality. It would be possible to code the arithmetic function // by hand, but since .NET provides it, that would be a waste of time private int Add(int i, int j) // i is the first value, j is the //second value { // add the numbers together using the .NET "+" operator int z = i + j; // return the value to the calling function // return z; // this code was updated to simplify the return statement, //eliminating the need // for a separate variable. // this statement performs the add functionality using the + //operator on the two // parameter values, and then returns the result to the calling // function return i + j; }//if you get here then you really f**ked/* our second do loop */ do {/// <summary> /// Toes the foo. /// </summary> /// <returns></returns> public Foo ToFoo()/** * Method declaration * * * @param table * @param row * * @throws SQLException */ void addTransactionDelete(Table table, Object row[]) throws SQLException {// Don't know why we have to do this//@TODO: Rewrite this, it sucks. Seriously./** * @author SomeUserWhoShouldKnowBetter * * To change this generated comment edit the template variable "typecomment": * Window>Preferences>Java>Templates. * To enable and disable the creation of type comments go to * Window>Preferences>Java>Code Generation. */Thread.Sleep(1000); // this will fix .NET's crappy threading implementation/*Added because someone asked me to add it*/// yes, this is going to break in 2089, but, one, I'll be dead, and two, we really ought to be using // a different system by then if (yearPart >= 89) { // naughty bits removed.... }/* Do the business */// this is a comment - don't delete// TODO: this is basically a copy of the code at line 743!!!//SFD Start ...code... //SFD End//This causes a crash for some reason. I know the real reason but it // doesn't fit on this line./** * Implements the PaymentType interface. */ public class PaymentTypePo implements PaymentType/// <summary> /// Disables the web part. (Virtual method) /// </summary> public virtual void EnableWebPart() { /* nothing - you have to override it */ }//TODO: Remove this comment.if (someFlag) { // YES DoSomething(); } else { // NO DoSomethingElse(); }/****************************************************************************** NAME: (repeat the trigger name) PURPOSE: To perform work as each row is inserted or updated. REVISIONS: Ver Date Author Description --------- ---------- --------------- ------------------------------------ 1.0 27.6.2000 1. Created this trigger. PARAMETERS: INPUT: OUTPUT: RETURNED VALUE: CALLED BY: CALLS: EXAMPLE USE: ASSUMPTIONS: LIMITATIONS: ALGORITHM: NOTES: ******************************************************************************//* Hmmm. A bit tricky. *//** * Gets the something * * @param num The num * @param offset The offset */ public void getSomething(int num, bool offset)dim J J = 0 'magic J = J 'more magic for J=1 to 100 ...do stuff.../** function header comments required to pass checkstyle *//* MAB 08-05-2004: Who wrote this routine? When did they do it? Who should I call if I have questions about it? It's worth it to have a good header here. It should helps to set context, it should identify the author (hero or culprit!), including contact information, so that anyone who has questions can call or email. It's useful to have the date noted, and a brief statement of intention. On the other hand, this isn't meant to be busy work; it's meant to make maintenance easier--so don't go overboard. One other good reason to put your name on it: take credit! This is your craft */try { someSeeminglyTrivialMethod(); } catch (Exception e) { //Ignore. Should never happen. };--- if LOGERR=1, errors are logged but debugging is difficult ;--- if LOGERR=0, errors are not logged but debugging is easy LOGERR=1if (returnValue ==0) doStuff(); else System.out.println("Beware of you, the Dragons are coming!");// initialise the static variable to 0 count = 1;..."AI code"... if(something) goto MyAwesomeLabel; //Who's gonna be the first to dump crap on me for this? ..."More Ai code"... MyAwesomeLabel: //It wasn't that hard to get here, right? ..."Even more AI code"...// Its stupid but it work/* http://youtube.com/watch?v=oHg5SJYRHA0 */[some code] // [a commented out code line] // this line added 2004-10-24 by JD. // removed again 2004-11-05 by JD. // [another commented out code line] [some more code]// it's a kind of magic (number) $descr_id = 2; $url_id = 34;/* this is a hack. ToDo: change this code *///the system can only handle 5 people right now. make sure where not //over if(num_people>20){# Let them send messages to the world #del self.irc_PRIVMSG # By deleting the method? Hello?// Return value does not matter return 0;/// <summary> /// Disables the web part. (Virtual method) /// </summary> public virtual void EnableWebPart() { /* nothing - you have to override it */ }/*======================================================================== FUNCTION DtFld_SetMin DESCRIPTION This local function sets a nMin member of the Dtfld struct. DEPENDENCIES None ARGUMENTS [in]me Pointer to the Dtfld struct. [in]val Value to set RETURN VALUE None. SIDE EFFECTS None NOTE None ========================================================================*/ /** @brief This local function sets a nMin member of the Dtfld struct.. @param [in] me Pointer to the Dtfld struct. @param [in]val Value to set @retval None @note None @see None */ static __inline void DtFld_SetMin(DtFld *me, int val) { me->nMin = val; }// Good luck//TODO: Remove this comment.#contentWrapper{ position:absolute; top: 150px; //80 = 30 + 50 where 50 is margin and 30 is the height //of the header }/// <summary> /// The Page_Load runs when the page loads /// </summary> private void Page_Load(Object sender, EventArgs e) {}#region This is ugly but a mas has to do what a man has to do Initialization of a gigantic array (...) #endregion // Aren't you glad this has ended?/****************************************************************************** NAME: (repeat the trigger name) PURPOSE: To perform work as each row is inserted or updated. REVISIONS: Ver Date Author Description --------- ---------- --------------- ------------------------------------ 1.0 27.6.2000 1. Created this trigger. PARAMETERS: INPUT: OUTPUT: RETURNED VALUE: CALLED BY: CALLS: EXAMPLE USE: ASSUMPTIONS: LIMITATIONS: ALGORITHM: NOTES: ******************************************************************************///Whoa, now that's a big if condition.if(some_condition){ do_stuff(); } else{ //An error occurred! }// This method takes two integer values and adds them together via the built-in // .NET functionality. It would be possible to code the arithmetic function // by hand, but since .NET provides it, that would be a waste of time private int Add(int i, int j) // i is the first value, j is the second value { // add the numbers together using the .NET "+" operator int z = i + j; // return the value to the calling function // return z; // this code was updated to simplify the return statement, eliminating the need // for a separate variable. // this statement performs the add functionality using the + operator on the two // parameter values, and then returns the result to the calling function return i + j; }# Below is stub documentation for your module. You’d better edit it //URGENT TODO: Reimplement this shit, the old code is as broken as hell… and we tought we solved all the problems// HACK HACK HACK. REMOVE THIS ONCE MARLETT IS AROUND[some code] // [a commented out code line] // this line added 2004-10-24 by JD. // removed again 2004-11-05 by JD. // [another commented out code line] [some more code]//we trick it, if forbidden, as if it had already existed/* this is a hack. ToDo: change this code */// this is messed up, and no one actually knows how it works anymore..//Forgive me if you can!/* FIXME: documentation for the bellow functionality - and why are we doing it this way */// Had to do this because DB is in Abbie Normal Form //Array where widgets live. Should have been called WidgetLand tWidget Widgets[MAX_WIDGETS]; # should never ever ever ever happen DEBUG and print "AYYAYAAAAA at line ", __LINE__, "\n"; die "SPORK 512512!"; public class A { protected<type> foo; public void setFoo(<type> fooVal); public <type> getFoo(); public void doSomething() { . . . foo = x.munge(); . . . } }; public class B extends A { /* redeclared here for clarity */ protected foo; public void doSomething() { . . . foo = x.munge(); . . . } CRect rectUm; // darn near killed'em // Since this file is loaded on every page, and since // I want the following function on every page, I'm going to // cheat and include it here even though it has nothing to // do with the other things in this file. // If you don't like it, bite me! * Single bit errors are detected and corrected * Double bit errors are detected * Undetected errors are ignored // Hocus Pocus, grab the focus winSetFocus(...) //if nothing else can be found to run, will go feed the ducks. //What the F**K are you looking at? # All your space are belong to perl $customer =~ s/ //g; // below here be scary parsing related things //WORKAROUND compiler bug with following code. //static final Class[] OIS_ARGS = {ObjectInpuStream.class}; //static final Class[] OOS_ARGS = {ObjectOutpuStream.class}; // Shouldn't ever happen... so close display if it does ecr_close_display(); break; // according to the Win98 docs, this should be 1 // according to the WinNT docs, this should be 2 // they are both wrong! // Return a status block suitable for inclusion in the reply // buffer to Control. Note: this code sucks. if ((eIOObjectType == Prototype_ && HR_FAILED(SchemaProcessor.ValidateAndOrCreate())) || (eIOObjectType == Production_ && HR_FAILED(SchemaProcessor.ValidateOnly())) ) { ASSERT(FALSE); // Don't put an assertion here; there are enough assertions in the // schema processor to kill a horse already. return HR_Failure; } // Ad Index scheming and plotting - Those with // heart conditions are advised to not continue // Bits 6, 5, and 4 must be 0, 1, and 0 respectively. // Otherwise, the oscillator burns crazy evil crack. //The following code was written by <developer name>. //Unless it doesn't work, then I have no idea who wrote it. /* And now, ladies and gentlemen, the chord from HELL! */
Вот еще одна статья 30+ комментариев к арт-коду, которые когда-либо писали в коде, которая вам также может понравиться.
Ознакомьтесь с фактическим вопросом Переполнение стека, чтобы узнать больше о том, что указано выше. Вы можете добавить свой топ в комментариях. Я добавлю это в исходный текст позже.
Примечание из JavaScript In Plain English
Мы запустили три новых издания! Проявите любовь к нашим новым публикациям, подписавшись на них: AI на простом английском, UX на простом английском, Python на простом английском - спасибо и продолжайте учиться!
Мы также всегда заинтересованы в продвижении качественного контента. Если у вас есть статья, которую вы хотите отправить в какую-либо из наших публикаций, отправьте нам электронное письмо по адресу [email protected] с вашим именем пользователя Medium, и мы добавим вас в качестве автора. Также сообщите нам, к каким публикациям вы хотите быть добавлены.
