ссылки для программистов

[avva]

Эта запись будет интересна только программистам.

1. (специально для веб-разработчиков) Прекрасная чашка:



2. Отличная подборка на stackoverflow: What is the best comment in source code you have ever encountered?.

Много хорошего (см. также комментарии на реддит). Отмечу такие шедевры, как

1. try {

} finally { // should never happen

}

2. return 1; # returns 1

3. // I'm sorry.

4. вот этот

Comments

[arno1251.livejournal.com]

Бесткомменты жгут :)

[mochalkina.livejournal.com]

о да. ;-)

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

// this line was changed on 23.03.2002.
// ... but what for? I don't remember. 30.09.2005

[arno1251.livejournal.com]

Прелестно :)

[javax-slr.livejournal.com]

Когда мы делали проект на ассемблере (ун. Бен Гурион, 1996), мы не успели написать комментарии, что могло сильно повлиять на оценку.

Тогда мы написали программку на Паскале, которая писала комментарии сама.
если видела ADD, добавляла ;ADDING
если видела MOVE, писала ;MOVING

и т.д.

Мы получили 100

[avva.livejournal.com]

отличная история :)

[vladimirgin.livejournal.com]

Кстати, о комментах. Буквально на днях задумался над этим (ибо надо было дебаггировать очередной чужой код) и вдруг понял, что на моей текущей фирме ПРАКТИЧЕСКИ НИКТО не пишет их (кроме меня). На прошлой фирме писали максимум процентов 20% народа. И это меня угнетает - неужели это я такой тупой, что мне необходимо писать комментарии хотя бы для того, чтобы не было проблемой разобраться в собственном коде через полгода?..

Так что интересно - а как у вас, принятно писать их

[javax-slr.livejournal.com]

Код должен быть понятен без комментов.

Пишем много javadoc - заголовки методов и классов, чтобы объяснить что метод делает, когда и что возвращает.

Внутри кода у нас почти нет комментов

[vladimirgin.livejournal.com]

Ну, я не пишу на java, поэтому javadoc не актуально. Насчет "Код должен быть понятен без комментов" в принципе соглашусь, если это не подразумевает, что надо отказаться от комментов как класса. Зачастую они необходимы. Хотя бы для того, чтобы дать понять, как именно этот кусок кода связан с предметной областью.

[javax-slr.livejournal.com]

Комменты для public API
Комменты для сложных алгоритмов и вычислений
Комменты в условиях
if (parent == null) { // happens for empty data sets

В других местах если хорошие имена переменных и методов - редко нужно

[vladimirgin.livejournal.com]

К этому нет вопросов, примерно такую же policy и я применяю.

[dimrub.livejournal.com]

> Ну, я не пишу на java, поэтому javadoc не актуально.

RTFM: Doxygen.

[megla.livejournal.com]

eto i est komentarii :)

[alon_68]

Вы не тупой.
Вы зануда :)

[spamsink]

Что-то с нумерацией: после пункта 2. снова пункт 1. :)

[avva.livejournal.com]

вложенный список :)

[spamsink]

Ты знаешь, что в Алголе нельзя было писать if condition1 then if condition2 then ... else... ? Так же и тут - неоднозначность вложенности пунктов 3. и 4.

[vinsent_ru]

options.BatchSize = 300; //Madness? THIS IS SPARTA!

Ухахаха :))

[vinsent_ru]

long long ago; /* in a galaxy far far away */

Гыыыы :)) Парвало

[vladimirgin.livejournal.com]

Разбирал один код, и мне понравился там один кусочек , точнее, наименование объекта в нем. Было это примерно так:
try
{
...
}
catch ( Exception HoustonWeHaveAProblem )
{
writeLog( HoustonWeHaveAProblem.ToString() );
}

[utnapishti.livejournal.com]

Помнится, один наш общий знакомый рассказывал, как он (в институте, ещё в России) дал одной девушке скопировать программу - домашнее задание, и её на этом поймали, так как она не стёрла комментарий "Я - конь-огонь".

[reut.livejournal.com]

ааааа, класс! спасибо. :)

[yms.livejournal.com]

насчет комментов - там высказана очень здравая идея по поводу google codesearch. адаптирую её:
http://www.google.com/codesearch?q=%D0%BF%D0%B8%D0%B7%D0%B4%D0%B5%D1%86

[yms.livejournal.com]

ну или просто
http://www.google.com/codesearch?q=%D1%85%D1%80%D0%B5%D0%BD

[cema.livejournal.com]

Хм, пожалуй.

[savvich.livejournal.com]

Exception up = new Exception("Something is really wrong.");
throw up; //ha ha

Ха ха ха

[alon_68]

О, какой класс! :)))
Немало вполне знакомых ситуаций :)

[cema.livejournal.com]

Чашка правильная.

[mikev.livejournal.com]

А что сейчас вместо CSS полагается использовать?

[cema.livejournal.com]

Сейчас полагается его использовать с умом. Впрочем, см. пункты про комментарии.

[putj.livejournal.com]

Кружка хороша.)

[dimrub.livejournal.com]

Мне очень понравилась чашка, которую я видел у Вагифа:

Cup<T>

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

[shure.livejournal.com]

const long* getPtr() {
return &*m_vect.begin(); /* sorry, stepanov */
}

[flaass.livejournal.com]

> /* You are not meant to understand this */
Однажды я стал виновником почти такого же комментария.
Делали генерацию переходов. Проблема была, что длина команды JMP зависит от длины прыжка, которая в том числе зависит от длин команд JMP. Я сочинил что-то и диктовал (на русском), а друзья-программеры синхронно переводили на Модулу.
Перевод заработал, но после его прочтения они добавили комментарий: "DONT change anything! Flaass knows why it works"

[ygam.livejournal.com]

Я несколько лет назад учил юного индийца программистскому уму-разуму на примере такого нарочито бесполезного комментария:

k++; // Increment k.

[alex-inside.livejournal.com]

АААА. Я в осадок выпал от чашки!!!

[olegstepanov.livejournal.com]

http://msmvps.com/blogs/brianmadsen/archive/2009/04/21/funniest-code-comment-ever.aspx