Каков лучший комментарий в исходном коде, с которым Вы когда-либо встречались? [закрытый]
518 ответов
// The ratio of a circle's circumference to its diameter. Remember to change
// this to 3.0 if you move to a site in Indiana.
#define Pi 3.1415927
Большой от пропущенного исходного кода Windows 2000:
!!!!!!! ПРИ ИЗМЕНЕНИИ ВКЛАДОК НА ПРОБЕЛЫ ВЫ БУДЕТЕ УНИЧТОЖЕНЫ!!!!!!! *
!!!!!!!!!!!!!! ВЫПОЛНЕНИЕ ТАК ТРАХАЕТ ПРОЦЕСС СБОРКИ!!!!!!!!!!!!!!!! *
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
// If you're reading this, that means you have been put in charge of my previous project.
// I am so, so sorry for you. God speed.
// human madable inconvenient. Way too sucks.
я все еще не полностью понимаю то, что это означает, но я нашел, что он очень верен о большом количестве кода.
.class {border:1px solid gold;} /* I pitty the fool */
Я использовал этого больше чем в одном случае, когда я сделал некоторое неочевидное упрощение в математической формуле, которую я не испытываю желание документировать:
//this formula is right, work out the math yourself if you don't believe me
Из одного из наших проектов.
Где-нибудь в конце одного исходного файла.
/*@ /\ /\ * @ / \/ \ ----- | | ---- |---\ | | /--\ --- | | ---- /--\ /--\ * @ / -- | | | | | / | | | | |\ | | | | * \---\ / \ | |---| ---- |--/ | | \ | | \ | ---- \ \ * | \------------------------/ /-\ \ | | | | | \ | | -\ | | \| | -\ -\ * | \-/ \ | | | ---- |---/ \--/ \--/ --- | \ ---- \--/ \--/ * \ ------O * \ / --- | | ---- /--\ |--\ /--\ /--\ * | | | | / | |\ | | | | | | | | | * | | | |----- ------- | | \ | ---- | | | | | | | /-\ * | |\ /| | \ WWWWWW/ | | \| | | | | | | | | | * | | \ / | | \------- --- | \ | \--/ |--/ \--/ \--/ * | | \--------------/ | | * / | / | * \ \ \ \ * \-----/ \-----/ */
Простой но эффективный комментарий, прежде меньше, чем безопасный взлом в некотором коде C++
// yikes
Вершина 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.
*/
//ALL YOUR BASE ARE BELONG TO US
... это заставило моего босса думать, что кто-то взломал в. Он не знал шутку.
//Abandon all hope ye who enter beyond this point
using namespace std; // So sue me
// This procedure is really good for your dorsolateral prefrontal cortex.Для тех из Вас, кто, по некоторой специфической причине, не зная о DPC, это - часть Вашего мозга, что световые сигналы, когда Вы глубоко заняты изучением чего-то нового.
На планировщике ядра linux 1.0 (sched.c):
Dijkstra, вероятно, ненавидит меня.
/*
* '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)
(...)
// The following strings are meant to be funny. Do not edit these strings // unless you are funny, too. If you don't know if you're funny, you're // not funny. If fewer than 2 people unrelated to you have told you that // you're funny, you're not funny.
//There can Only Be one HIGHLAN....err..Singleton
public class SomeSingleton
{
...
}
// Any maintenance developer who can't quote entire Monty Python
// movies from memory has no business being a developer.
const string LancelotsFavoriteColor = "$0204FB"Другой классик, Donald Knuth не меньше:
Остерегаются ошибок в вышеупомянутом коде; я только доказал, что это исправляет, не попробованный это.
Приблизительно 10 лет назад я работал при обработке изображений, видеокадры сканирующего микроскопа для обнаружения перемещения ячейки. Я работал в особенно intricated функция и решенный, чтобы выйти и выпить с друзьями. Когда я возвратился домой, я работал немного, но не слишком много, потому что я был пьяный. Утро после того, как я нашел полностью смешанную функцию с 10 строками со следующим комментарием (очевидно, записанной мой другим сам):
/* Ah ah ah! You'll never understand why this one works. */
Самая странная часть была то, что это даже работало.
/**
* If you don't understand this code, you should be flipping burgers instead.
*/
// error codes
#define ERROR_SUCESS 0
#define ERROR_SUCCESS_IS_MISSPELLED 1
Другие коды ошибок не определены.
Мне всегда нравилось то, что Пол ДиЛаскья писал в заголовках своих файлов:
// If this code works, it was written by Paul DiLascia. If not, I don't know
// who wrote it
Из просочившегося исходного кода Win2K:
// Величина этого хака выгодно отличается от национальной долг.
Я разместил это «заявление о лицензии» в выпущенном мной шаблоне 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.
*/
// if i ever see this again i'm going to start bringing guns to work
From a battery monitor module in an embedded system:
// batmon.c drives the rastamobile
//I'm sorry, but our princess is in another castle.
//uncomment the following line if the program manager changes her mind again this week