Каков лучший комментарий в исходном коде, с которым Вы когда-либо встречались? [закрытый]
518 ответов
try {
doSomething();
} catch(err) {
// Die quietly
alert(err);
}
Просто найденный этим в части нашего кода PHP
$s=2; // chicken and bacon wrap for lunch
, Насколько полезный, к счастью $s был сам объяснительный
УЖАСНЫЙ патч для декодирования (Перевод итальянским языком):
/**
*@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...
*/
При работе над некоторыми веб-сайтами я нашел это в начале встроенного JS:
я чувствую себя настолько грязным, делая это, но парень хотел его в.NET
//Iterate by one
$i++;
, К сожалению, это было моим, во время мой "Должно прокомментировать все фазу".
struct core_unlocker
{
core_unlocker(lock)
{
m_lock = lock
unlock(lock) //Abandon All Locks, Ye Who Enter Core!
}
~core_unlocker()
{
lock(m_lock)
}
private:
Corelock m_lock;
}
{
This is a gathering place for all unit tests.
Create a TUnitTestWrapper, then call "RunAllUnitTests".
This class will create an instance of each thing to be tested, and call each of
their unit tests.
It does not really do any testing on it's own; it just gives a common place from
which to call everyone else's tests.
This way, one day, we can automate our testing with each build. [Cue laughter]
}
-- Change Log: Not needed. The code is perfect 'cause I wrote it.
-- If you change it, it will break.
я посреди рассмотрения некоторых комментариев к коду, чтобы проверить, что они имеют смысл и видели скромную строку выше.
Я когда-то работал над исходным кодом Windows 3.0. (Не, я спешу добавлять как сотрудник Microsoft!) Там я столкнулся с загрузчиком файла, который пошел повторно используемый многократно и имел один пример некоторой противной трамбовки (только, чтобы показать, насколько умный автор был).
Эта путаница повторно используемого кода выполнялась с блоком Intel jmp инструкция (посреди кода C), который перешел в маркировать "we_are_not_in_kansas_any_more_toto".
Case 1:
...
break;
...
//I don't want do do this but [my coworker] says it's part of the code standard
default:
break;
Это настолько более хорошо, чем страшные официальные уведомления и правовые оговорки, которые Вы видите во многих заголовках комментария. От 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.
*/
управляемый для вставки этой плохой игры слов в наш код
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 */
...
}
<!-- Here it is -->
Других комментариев нет. До сих пор я не знаю, что это было.
Мой личный фаворит - документация в форме лимерика :
Subclassing made Zope and TR
much harder to work with by far.
So before you inherit,
be sure to declare it
Adapter, not PyObject*
Это, вероятно, портит шутку немного, но так как это немного неясно, я объясню:
«TR» здесь относится к «Искривленной реальности». Zope 2 и оригинальный пакет twisted.reality широко и неудачно использовали множественное наследование, что может затруднить понимание того, что происходит, когда вы видите вызов метода. Zope 3, Twisted себе и twisted.reality наследники (включая самых последних Imaginary ) вместо этого, как правило, предпочитают компонентный состав.
Вся эта функция довольно хороша (из драйвера Linux sunhme.c для сетевой карты, которую прозвали Happy Meal от Солнце. Потому что карта, которая была до этого, была "Большой 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. */
}
Я не У меня нет кода для обмена, но представьте себе этот сценарий. Примерно через месяц или два после того, как наш системный администратор Linux отправился на более зеленые пастбища, я имел удовольствие открыть написанный им сценарий оболочки. Я не могу вспомнить, почему мне нужно было его редактировать, но это не главное. Важно то, что длина сценария составляла около 40 строк. Я прокрутил мимо комментариев (которых было 37 строк), чтобы получить действительный рабочий код (3 строки). Код был отличным, но мне было любопытно - зачем комментировать 37 строк? Итак, я прокрутил наверх и приступил к чтению. К моему удивлению, комментирование было рэпом о том, что сделали три строки кода и как его изменить. Лучшая часть - это была частичная кража «Ничего, кроме AG Thing» от доктора Дре и Снупа DO DOUBLE G. Спасибо Брайан!
Примерно через месяц или два после того, как наш системный администратор Linux отправился на более зеленые пастбища, я имел удовольствие открыть написанный им сценарий оболочки. Я не могу вспомнить, почему мне нужно было его редактировать, но это не главное. Важно то, что длина сценария составляла около 40 строк. Я прокрутил мимо комментариев (которых было 37 строк), чтобы получить действительный рабочий код (3 строки). Код был отличным, но мне было любопытно - зачем комментировать 37 строк? Итак, я прокрутил наверх и приступил к чтению. К моему удивлению, комментирование было рэпом о том, что сделали три строки кода и как его изменить. Лучшая часть - это была частичная кража «Ничего, кроме AG Thing» от доктора Дре и Снупа DO DOUBLE G. Спасибо Брайан! Примерно через месяц или два после того, как наш системный администратор Linux отправился на более зеленые пастбища, я имел удовольствие открыть написанный им сценарий оболочки. Я не могу вспомнить, почему мне нужно было его редактировать, но это не главное. Важно то, что длина сценария составляла около 40 строк. Я прокрутил мимо комментариев (которых было 37 строк), чтобы получить действительный рабочий код (3 строки). Код был отличным, но мне было любопытно - зачем комментировать 37 строк? Итак, я прокрутил наверх и приступил к чтению. К моему удивлению, комментирование было рэпом о том, что сделали три строки кода и как его изменить. Лучшая часть - это была частичная кража «Ничего, кроме AG Thing» от доктора Дре и Снупа DO DOUBLE G. Спасибо Брайан! Не могу вспомнить, почему мне нужно было его редактировать, но это не главное. Важно то, что длина сценария составляла около 40 строк. Я прокрутил мимо комментариев (которых было 37 строк), чтобы получить действительный рабочий код (3 строки). Код был отличным, но мне было любопытно - зачем комментировать 37 строк? Итак, я прокрутил наверх и приступил к чтению. К моему удивлению, комментирование было рэпом о том, что сделали три строки кода и как его изменить. Лучшая часть - это была частичная кража «Ничего, кроме AG Thing» от доктора Дре и Снупа DO DOUBLE G. Спасибо Брайан! Не могу вспомнить, почему мне нужно было его редактировать, но это не главное. Важно то, что длина сценария составляла около 40 строк. Я прокрутил мимо комментариев (которых было 37 строк), чтобы получить действительный рабочий код (3 строки). Код был отличным, но мне было любопытно - зачем комментировать 37 строк? Итак, я прокрутил наверх и приступил к чтению. К моему удивлению, комментирование было рэпом о том, что сделали три строки кода и как его изменить. Лучшая часть - это была частичная кража «Ничего, кроме AG Thing» от доктора Дре и Снупа DO DOUBLE G. Спасибо Брайан! но мне было любопытно - зачем комментировать 37 строк? Итак, я прокрутил наверх и приступил к чтению. К моему удивлению, комментирование было рэпом о том, что сделали три строки кода и как его изменить. Лучшая часть - это была частичная кража «Ничего, кроме AG Thing» от доктора Дре и Снупа DO DOUBLE G. Спасибо Брайан! но мне было любопытно - зачем комментировать 37 строк? Итак, я прокрутил наверх и приступил к чтению. К моему удивлению, комментирование было рэпом о том, что сделали три строки кода и как его изменить. Лучшая часть - это была частичная кража «Ничего, кроме AG Thing» от доктора Дре и Снупа DO DOUBLE G. Спасибо Брайан!catch
{
// you’re fucked
// write out the file somewhere and start screaming “Connection down! Connection down!”
}
/**
* 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";
We had a group project to create a Connect 4 AI using Min-Max trees. In our move-scoring function, we had it calculate a score for the board, and above that block of code there was this comment:
// This is kind of almost useless
But it gets better. Our instructor gave us some sample code from a crude AI he had made, and he left a great comment:
// We also add/subtract some points based on what's going on, on the bottom
// row. (I think this is retarded, but apparently when I coded this up
// back in 1999 I didn't.)
//Time log says you've been here for 15 hours GO HOME, your code is hobo
/ * Это точная копия ужасного взлома - много месяцев назад старый PortfolioServer был модифицирован, чтобы возвращать сделки с наличными в блоке «optionTrade», потому что разработчик на стороне клиента был слишком ленив, чтобы получить их XPaths правильно. Их лень прослеживается сквозь века и означает, что нам нужен подобный взлом здесь ... * /
""".........................:~+?7$$$ZZZZZZZ$$$7I+=:,............................
........................~+7ZZZZZOZZOOZOZZOZOZOOZZZZZ7?~:........................
......................,~7$ZZOOOOOZOZOZOZZOOZZOZOOOOOZ$$I,.......................
...................,=I$OOZOZOZZOOOZZOZOOOOZOZZZOOZZZOZZOZI=:....................
.................:?$ZZOOZZOZOZZOOOZZZOOZOZOZZZZZZZOZZOZOOOZ$I~..................
................IZOOOZOOOZZZOZZZZOZZOZOOOOZOZZZOOZZZZOOZOZZZOZ7=................
...............~ZZOZZOZOOZOOZOZOZZOZOZOZZZZZOZOZZOZOOZOZZOOOOZZ7................
.............:IZOOZOZZZZOZOZZOZOOZOZOZOZZOZOOZOOOOZOZZZZZOZOZZOOI~..............
...........,+$ZOOZZOZOZOZOZOZZOZOZOOZZOZZOZZOZOOOOZOZZOZZOOZOOOOO$?:............
..........:IZZOOOZOZZZZOOZOOZOZOZZOZOZZZZOZOOZOZZOZOZOZOOOOOOOZZZOZ7~...........
..........+$OOZZZOZZOOZOOZZZZOZZOZOZZOZOOOZOZOZZOZOZOZOOOOOZ$$77I77$+:..........
........,?$OOZZZZZZZOZOOOZOZZOZZZOOZOZOOOOZOZZZOOZOOZOOO7?~:,.......,...........
........+ZOOZZZZZOZOOZOOZZZZOZZOOOZZZOZOZOOZZOZOZZZOOO$?........................
........$ZOZZZOZZZZOZOOZZZOZOZZOOOOOOOOOOOZOZOZZOZOO$?,.........................
.......:ZOOZOZOZZOOZZOZOZOZOOOZOOOOOOOOOOOOOOOZOZOOZI:..........................
.......+OOOZOOZOZOZOZZZOOZOOZOOO$I+=~:::~+I$OOOOOOZ?:........,:=,...............
......:7ZOOZOZZOOOZOZOZOOZOOZ$I=............:?$OOZ7:.......:IZOOZ?,.............
......=$OZOZOOZOOOOOZOZZOOZ7=,................:?O$+.......~7OOOOOZ+,............
.....,?$OOOOOZZZZOOOOOOZOZ?,....................ZZ=.......=$OOZOOZ+,............
.....:IZOZZ$777I7$ZOOOOOZ7~.....................$Z=.......~7OOOOO7=.............
.....:+?~:,.......,~IZOO7~........~+II?=........?$?,.......:I$ZZ?:..............
.....................+ZO=,......:IOOOOOZ:.......=7$~............................
.....................:IO~.......=OOZOZOO=,......~7O7~...........................
...........:~:.......:IO~.......+OOOOZOO=.......~78Z?,.................,:.......
..........:IZ7~......+ZO~.......:7OOOOO$,.......+$OOZ7=,.............:?$=.......
...........,,.....,=7ZOO+,.......,=II?=:........7OOOOOOZ=:,.....,:=I$ZOO=.......
....................,:+$7=.....................~OOOZZZOOOZZ$$7$$ZOOOOOOZ=.......
......................:?Z?,...................:?OZOOZOOZOOOOOOOOOOZOZOZO=.......
............,::,.......,OO7:................,+$OOZOZOOZOZZOZOZZOOZOZOZOO=.......
...........~$8OI........$OOZI~,.........,:=IZOOZOZOZOZOOOZOZOZOOOZZZOZOO=.......
...........:??=:.......:OOOOOZZ7+=~~==+?$ZOOOOZOOOZOZOZOOZOZOZZOZZOZOZZO=.......
............::,.......,+OOZOOOOO$7777$$ZOOOOOZOZZZZOZOZZZOOZOZZOOOZOOZOO=.......
.....................=7OOZOOZOOZOOOOOOOOOZZZOZOZZOZOZOZOOOZOZOZZOZOOZOOO=.......
................,:=I$OOOZZOOOZOOOOOZOZOZZZZZOOZZZOZOZZZOOZOOZOZOZOZOZOOZ=.......
...........:~+?7ZOOOOOOZZZOZOOZOZOOZOZOZZOZZOZOZZZZOZOZZOZOZOZZOZOOZOOOZ=.......
........$$ZOOOOOOOOZOZOZZZZOZOZOOOZZZOZZZOZOOZOZZZZZZZZOOOZOOZZZOZOOZOOZ=.......
.......~OOZOOZZOOZZZZZZOOZOZOZOZZOOZOOZZZOZZOZOZZOZZZOZOOOOOZOZOZOOZOOOZ=.......
.......~OOZOOZZOZZOZOZZOZZOZOOZOZOOZOZOZZOZOOZOZZOZOZOZOZOOZOZOOOZOOZOZO=.......
.......~OOZZZOZOOOZOZOZZOZOZOZOZOOZOOZOOOOZOZOOZOOOZOOOZOZZOZOZOOZZOOOOZ=.......
.......~OOZZOZOZZZOOZOOZOZOZOZZOZZZZOZZZZOZOZZOOOOZ$ZZZZZZOZZZOZZOZOZZZO=.......
.......~OOZZOO$??$OOZOOZZOOZOZOZ+~IZOOOZOZOOZZOOZI==IZOZZOZOOZOZZOZI~=7O=.......
.......~OOZO$I:..~IZZZOZOZOZOZ$+...=7ZOOZOOZZOZZ=,..,=$ZZOZZZZZOZI~...,?=.......
.......~OOOZI:....:IZOOOZZOOO$+:....~7ZOZOZOZOZ$,....,=$OOZOOOZOI~.....:~.......
.......~OZI~........~IZZZOZ$?:........=IOOZZZ$+,.......,$ZOOOZZ7................
.......=7~............~IOZI:............7ZO$+:..........,=7ZZ7=,................
.......,,...............=~...............~=:..............,~=...................
GlassGiant.com"""
print "Hello World!"
Control + A, переписать
Этот комментарий был добавлен в систему контроля версий в предыдущем проекте в качестве проверки в комментарии.
// TODO: what the hell is this all about?
А затем некоторый закомментированный код.
Это было найдено в нашем коде в работе ранее сегодня. Я не уверен, стоит ли мне смеяться или плакать ...
Это было для пользовательского DHCP-сервера, который мы использовали в общежитиях университета для помещения компьютеров в «чистые» или «грязные» пулы IP-адресов в зависимости от того, были ли они зарегистрированы / установлены исправления и антивирус:
public boolean getDirty (String MAC) // not as fun as it sounds