Подробный и понятный комментарий!

← →
Anatoly Podgoretsky © (2004-07-14 11:21) [80]

> Как надо:
> mov a, 5 ; установить начальное значение счетчика

А надо не так, а

mov a, {Name}CounterStartValue

Для Паскаля

for I:= CounterStartValue to CounterEndValue do

и ни каких комментариев, ни здесь ни в других местах не понадобится.

← →
Aldor_ (2004-07-14 12:35) [81]

Юрий Зотов © (14.07.04 06:11) [74]

<offtop>
Кстати, Юрий, на счет Этапа 6: мне право неудобно напоминать, но если нужна какая-либо поддержка, в том числе и моральная, всегда поможем чем сможем.
</offtop>

← →
КаПиБаРа © (2004-07-14 12:50) [82]

Когда-то давно слышал что в пентагоне на 1 строчку программы приходится 200 строк комментария. Вот это программы там. Не программы а романы. Зачитаешься :)

← →
PythoN (2004-07-14 13:13) [83]

Всем здрасте!
На прочтение вышенаписанного у меня ушло н-ое кол-во времени, но я все таки до читал до последней фразы.
Мне хочеться сказать и свое слово.
Как я понял тут сложилась такая ситуация - "Денис" + небольшое кол-во людей, которые поддерживают его идею ( их мало) и все остальные.
Никто не пытаеться прийти к единому продуктивному решению, все кичятся своей ученостью и мастеровитостью. Стыдно господа, стыдно. Детский сад. ОДни : "МЫ вот ЭТО" Остальные : " Да мы! вообще !!! нам это не надо!!! мы круты!!!" ... спешу вас растроить - крутыми бывают тока яйца.
Вот такое впечатление создалось от вашей дисскусии. Я могу это утверждать как третья сторона. Но это мое субъективное мнение.

Если честно, то я не понял суть это идей. Идея комментировать каждую строчку обреченна на провал, потому что в коде существуют связи между частями и когда у тебя несколько тысяч строк кода, кол-во ссылок, причем иногда перекресных просто огромно. Суть алгоритма и программы в целом - как раз эти связи и ссылки ("нитки" могут убежать на внешные источники, что еще больше услажняет дело) , а комменитрование каждой строки понимание этих связей никоим образом не облегчит.

Другой вопрос, что комментариев вообще нет. Я понимаю что разобраться при желании можно во всем, но с комментарием все таки легче. Панамский славо богу ложками десертными не капали...

С уважением. PythoN.

← →
Думкин © (2004-07-14 13:17) [84]

> [83] PythoN (14.07.04 13:13)
> Как я понял тут сложилась такая ситуация - "Денис" + небольшое
> кол-во людей, которые поддерживают его идею ( их мало) и
> все остальные.
> Никто не пытаеться прийти к единому продуктивному решению,
> все кичятся своей ученостью и мастеровитостью. Стыдно господа,
> стыдно. Детский сад. ОДни : "МЫ вот ЭТО" Остальные : " Да
> мы! вообще !!! нам это не надо!!! мы круты!!!" ... спешу
> вас растроить - крутыми бывают тока яйца.

А теперь внимательно прочитай ветку по второму разу, потом свое и скажи последние фразу в зеркало. ИМХО.

← →
Тимохов © (2004-07-14 13:27) [85]

> крутыми бывают тока яйца.

и косогоры.

← →
PythoN (2004-07-14 13:56) [86]

> А теперь внимательно прочитай ветку по второму разу, потом свое и скажи последние фразу в зеркало. ИМХО.

А можно все таки по конкретнее свои мысли формулировать?
А не тайнственно - загадочно.
И еще пытаться меня устыдить в чем то - пустая трата времени.

← →
Sandman25 © (2004-07-14 14:31) [87]

[83] PythoN (14.07.04 13:13)

Ну Вы написали... "Я идею не понял, но не врубаюсь, почему она вам не понравилась и вы не попытались придти к компромиссу"...
Да потому что мы ее поняли! :)
Если кто-то знает, что он прав, причем прав на 100%, то ему нельзя идти на компромиссы, так как это будет против истины.

← →
NailMan © (2004-07-14 15:01) [88]

Давайте и я выскажусь за и против:

Денис
В примере c "Pos" все становится понятным если навести на Pos мыша, кликнуть и нажать CTRL+F1. Станет понятным и что делает эта функция и что надо в нее совать в качестве параметров. Также становится понятным что Pos - это сокращение от слова Position, а не Postscriptum какой-нить, так что интуитивно будет понятно что это нахождение позиции в чем-то. А вот в чем - это подскажет F1 или даже точнее CTRL+F1.

Hint: Новичек-"блондинка" должен знать как отче наш что главная клавиша на клавиатуре - это F1, а не левая кнопка мыши.

Коментарии:
В своих проектах(DShow-медиа-плеер и Direct3D9-игра) я коментирую в основном только в секциях Interface, тоесть объявления. делаю это я не для себя(свои прои я буду знать до конца программерской жизни), а для потенциальных напарников, которым нужно будет не то КАК получается результат выполения функции, а КАКОЙ результат получится и что для этого нужно подсунуть функции.

В заголовках это все прокоментированно. Кроме того в структурах указывается на кой хрен нам это поле/свойство и на кой другое.

Сам код практически не коментируется(разве что секции кода если функция/процедура большая).

Вобщем что я хочу сказать, описываю только то что необходимо для понимания процесса. Большую роль в написании понятной программы, для другого человека, к тому же еще с небольшими знаниями в программизме, играют информативные названия переменных и процедур/функций. Хороший тому пример тот же самый ShowMessage. Ну только полный даун-"блондинка"
не знающая ни слова по-англицки встретит затруднения с этой процедурой, точнее с ее назначением, к тому же и ленивый даун.

Коментаррий он на то и коментаррий чтобы прокоментировать какой-то непонятный кусок, но прокоментировать так чтобы не описывать какие-то действия дословно, а описать только мысль.

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

Вот взять к примеру меня:

если меня в форуме спрашивают какой-то алгоритм(недавно спрашивали в Играх), то я вставляю в постинг куски своего кода и специально для этого человека(и других интересующихся) его расписываю, так как я не любитель кому-то давать что-то свое без пояснений. Но и здесь я не прибегаю к твоей идее коментировать буквально все подряд(типа 200 строк коментарриев на 1 строку кода). На то он и пример, чтобы ты сам допер с некоторой помощью до логики алгоритма, а не получил его суть на блюдечке с голубой каемочкой.

Единственный язык который без коментарриев сложно воспринимается(когда какой-то большой и сложный кусок программы) - это асм. Тут я всеми руками за подробный коментаррий, но таки не на каждой строчке, а на той, где действие неясно из контекста.

> 2)Логика работы - это поверхностный обзор если не понимать
> каждый пункт.

Чё-чё?

Тоесть если я понимаю логику работы функции, то я лишь имею поверхностное представление о ее реализации?

ЗЫ:
Короче...идея имхо бредовая, хотя не лишена какого-то внутреннего смысла...

---
WBR, NailMan aka 2:5020/3337.13

← →
Денис (2004-07-14 19:15) [89]

В целом - убедительно, если опустить хамоватые замечания некоторых товарищей, которые эту убедительность пошатывают. Могу им только заметить, что коли тема моя так абсурдна, то держит вас здесь исключительно желание потрепаться. А значит клоунствуем мы тут совместно, и ты nikkie - не меньше меня.
Кстати клоун - тяжелая и уважаемая профессия, запиши если не знал.

Тут всерьёз повеяло профессионализмом. А я совершенно не собирался обращаться к профессионалам. То что я - любитель и новичок и так понятно, соответственно цели мои - любительские. И спорить с профессионалами я разумеется не буду.
Тем более, ни кого я не призывал комментировать чего либо и как либо.
Целью моего обращения был поиск людей которым возможно интересно было бы поделиться своими успехами и "открытиями".
А идея была в том , что множество новичков грызут науку програмирования с разных сторон, и объединившись могут обогатить друг друга, преумножить свои достижения.
Вы скажете - какой прок от их достижений?
А вот какой: пояснения профессионала и пояснения докопавшегося досути новичка имеют большую разницу.
Профессионал, объясняя что либо, часто упускает вещи которые не кажутся ему требующими объяснения, само собой разумеющимися. Поэтому обычно мало прочитать одну статью - лишь прочитав несколько, всё становится на свои места.
Новичок же, чьё открытие ещё свежо - не упустит ничего из мелочей, если конечно у него есть жажда докапываться до сути, а не просто код вставлять. Не обойдёт нюанс, потому что каждая мелочь ему стоила.
Но писать статьи ему конечно рано, а вот разобрав код, объяснить его другим - в самый раз.
А пример перед вами: разнесчастный type.
Для вас что TFindWindowStruct - тип , что TForm1 = class(TForm). Всё одно - свои типы.
А новичок полезет в справку с TFindWindowStruct, и может не найти там ни шиша(в отличие от TForm).
А почему? Правильно, потому что этот тип - запись, тип определяемый програмистом и может иметь какое угодно имя, в отличие от TForm.
Именно это я и вкладывал в понятие СВОИ, но вам профи этого уже не объяснишь.

Поэтому, раз тут ненароком собрались одни профессионалы, мне остаётся лишь сказать:"Обана! Ребята, извините я немножко ошибся дверью. Долго же мы базарили пока это выяснили!"

← →
Тимохов © (2004-07-14 19:23) [90]

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

а что - идея.

← →
Nous Mellon © (2004-07-14 19:25) [91]

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

Зачем друг другу? Бить надо Дмитрия О(не сильно, в воспитательных целях) ну и DiamondSharka(сильно в тех же целях)
:)

← →
Тимохов © (2004-07-14 19:31) [92]

> Nous Mellon © (14.07.04 19:25) [91]

да пошутил я ...

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

Поэтому - тебе не нарвится автосхема, получи. А потом пивка...

← →
Nous Mellon © (2004-07-14 19:37) [93]

> да пошутил я ...

да я тоже :)

← →
Тимохов © (2004-07-14 19:42) [94]

> Nous Mellon © (14.07.04 19:37) [93]

да понял я.

Сколько не комментарь - ламер (если угодно, новичек) не поймет.

← →
Юрий Зотов © (2004-07-14 19:52) [95]

> Денис (14.07.04 19:15) [89]

> Поэтому обычно мало прочитать одну статью - лишь прочитав
> несколько, всё становится на свои места.

Вот в ЭТОМ Вы совершенно правы. Я бы даже сказал так "лишь прочитав несколько десятков книг всё только начинает потихоньку становиться на свои места".

Заметьте - несколько десятков, а не просто несколько.

И книг, а не статей. Серьезных и толстых. Уж точно не из серии "что-то там для чайников за 21 день".

И даже после этого - только начинает.

А без этого не помогут никакие комментарии. И никакого другого пути просто не существует.

Вот такие пироги.

← →
Nous Mellon © (2004-07-14 19:53) [96]

> Сколько не комментарь - ламер (если угодно, новичек) не
> поймет.

по-моему ты смешиваешь два разных понятия? :)

← →
Тимохов © (2004-07-14 19:59) [97]

> по-моему ты смешиваешь два разных понятия? :)

может быть :)
ламер - подкласс новичка - это воинствующий новичек

← →
Anatoly Podgoretsky © (2004-07-14 20:02) [98]

Тимохов © (14.07.04 19:23) [90]
За автосхему это в другой ветке, благо она заведена и пока в пределах видимости.

← →
Тимохов © (2004-07-14 20:04) [99]

> Anatoly Podgoretsky © (14.07.04 20:02) [98]

прошу прощения, виноват.
но это же уже имя нарицательное !!! :)))

← →
Nous Mellon © (2004-07-14 20:09) [100]

> может быть :)
> ламер - подкласс новичка - это воинствующий новичек

Скорее это мертвый подкаласс новичка не имеющий своих более продвинутых поотомков отличие от новичка талантливого, который постигая новое, становится объектом другого класса, класса потомка, с расширенными возможностями. И только самые талантливые постигают всю иерархию :)

← →
Vlad © (2004-07-14 20:12) [101]

> Тимохов © (14.07.04 19:23) [90]
> а предлагаю иногда собираться и бить друг другу рожу приговаривая,
> а это тебе за автосхему, а это за универсальный комментатор.

А я предлагаю мордобои устраивать вот в этой ветке
http://delphimaster.net/view/14-1089777990/
Там будут собираться те, кто недобил друг другу морды в основных форумах по причине закрытия ветки :-)

← →
Григорьев Антон © (2004-07-14 20:20) [102]

Так, я, кажется, что-то пропустил. Что такое автосхема?

← →
kirasuki © (2004-07-14 20:34) [103]

Приветствую вас, уважаемые мастера. По-моему, предмет вашего обсуждения давно придуман, и называется он javadoc, doxygen (www.doxygen.org) и т.д. - автоматизированные средства построения документации. К сожалению, разработчики такого замечательного продукта как Delphi не удосужились включить подобную вещицу в исходный комплект поставки, тк видимо, заведующим отдела сопровождения программного обеспечения у них работала Эллочка Людоедка, либо просто по незнанию.

← →
Думкин © (2004-07-15 06:50) [104]

> [102] Григорьев Антон © (14.07.04 20:20)

#ifdef offtop
Ты многое потерял. Суть вроде как такая:
1. Есть паскалевский код.
2. По нему строится блок-схема.
Но...вся прелесть не в этом а в том как это все работает и ...исходники и вечная претензия на новое и гениальное.
Еще было кодирование текста в картинки, правда обратно не раскодировывалось. После просмотра исходников - шок у всех на всю жизнь. Ну и т.д. ну и т.п.
Автор тут - с персональной веткой, можешь подробности взять у него.
#endif

← →
Денис (2004-07-19 08:18) [105]

Мне, признаться , тоже любопытно, что за Автосхема такая.
Если автор не против, где можно найти изложение идеи?

← →
N170 (2004-07-19 08:33) [106]

Дайте ссылку для скачки.

← →
Baron © (2004-07-19 10:49) [107]

Юрий Зотов © (14.07.04 06:11) [74]
>Денис, Вы просто не представляете себе величину этого разрыва.
>Понимаете, человек, которому еще нужно рассказывать про "тип
>запись" уже не догонит меня ни-ко-гда.
Я бы не стал так категорично. Хороший ученик, как правило, превосходит в последствии учителя. Так как к уже готовым знаниям учителя, прибавляются свои. Считаете ли вы себя не превзойденным?
//////

Насчет комментариев, думаю это излишне. Язык на то он и язык что бы его читать. Не будем же мы комментировать каждое написанное нами слово, выдержками из правописания русского языка. Тому, кто читать не умеет все ровно по понятным причинам будет непонятно.
По сабжу думаю автору лучше прокомментировать все в отдельном месте вне кода. И пусть распространяет свой код + комментарии в отдельном файле. ИМХО учить надо правила, а не примеры ошибок.

PS. Ох уж и утомительное чтиво здесь. Запарился все читать, так и не дочитал 3 поста. Пока читал, наверное, еще 10 напостили.

← →
Юрий Зотов © (2004-07-19 15:14) [108]

> Baron © (19.07.04 10:49) [107]

Дома стоят 2 шкафа книг. Несколько сотен. И, в основнм, вовсе не "для чайников". Плюс когда-то прочитанные книги из библиотек.

Чтобы начинающий человек меня догнал, ему тоже придется их все прочитать и усвоить. А еще закрепить все прочитанное на практике. Сколько у него на это уйдет времени?

У меня ушло 35 лет. И у него уйдет примерно столько же (тем более, что ведь и я не стою на месте). А за это время я успешно перейду в мир иной
- так чко не суждено ему быть моим конкурентом. Поздно.

Вот в чем весь фокус.

Юрий Зотов © (19.07.04 15:14) [108]
У него так не выйдет, для начала он не сможет найти тех книг, и плюс технологии так стремительно развиваются, что глазом видно как отстаешь.

← →
Денис (2004-07-19 19:57) [110]

Мне представляется, что дело вовсе не в количестве прочитанных книжек, а в достоверности и в "закреплении" в голове знаний, которое это количество определяет.
В принципе полезную инфу из 10 подобных книг можно экстрагировать и в одну, - это даст достоверность и удобство.
Но для закрепления, читать её придётся всё равно не меньше 10 раз.
В этом есть смысл, но для составления такой книги нужен талант.

Юрий Зотов © (19.07.04 15:14) [108]
Вы считаете, что текст более эффективное средство коммуникаций, чем общение человека с человеком?
Все знания, которые вы накопили за эти годы вы за более короткий промежуток времени сможете передать способному на то человеку. Учить н-н-амного легче в молодости. Не заметите, как вас обойдут молодые специалисты.
Что бы исключить массу ненужных вопросов скажу - что я не ставлю под сомнение вашу профессиональную компетенцию.

← →
Денис (2004-07-20 08:10) [113]

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

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

> Денис (20.07.04 08:10) [113]
> Но почему то когда о подобном заходит речь, молодых учеников,
> страждущих получить знания из первых рук, обвиняют в ленности
> и паразитировании.

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

> Baron © (19.07.04 22:45) [112]

> Вы считаете, что текст более эффективное средство
> коммуникаций, чем общение человека с человеком?

Речь идет не просто о коммуникации, а об обучении. А обучить можно только того, кто сам этого хочет и на это способен. А хотение и способность априори предполагают желание и умение самостоятельной работы с книгой (или иным источником). Роль же преподавателя - сначала дать базу (чтобы человек мог понимать написанное), а затем - контролировать усвоение материала и разъяснять непонятные места.

И все. Невозможно человека научить - можно лишь помочь ему научитьСЯ. Вот в этом "СЯ" и есть все дело.

И если человек работать самостоятельно не хочет или не может, то не помогут ему никакие преподаватели. А если хочет и может, то, в принципе, ему и преподаватели не нужны - он все равно своего добьется. Правда, без преподавателей он затратит гораздо больше труда и времени.

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

Что же касается "Не заметите, как вас обойдут молодые специалисты", то кто же против? Флаг им в руки. Только молодым специалистам это не грозит. Пока они будут "обходить", быть "молодыми" они вполне успешно перестанут. Что, кстати и наблюдается в реальности.

А действительно молодые специалисты пока что иногда даже не могут понять мой код, не то что написать подобное самому (и это при совершенно простом и прозрачном стиле). Так что даже и в кодинге им еще довольно долго придется в догонялки играть - а уж о постановке задачи, поиске способа ее решения и о проектировании и говорить нечего.

Опытный человек, опытен во всем :)))
Особенно в сарказме!

> Только молодым специалистам это не грозит. Пока они будут
> "обходить", быть "молодыми" они вполне успешно перестанут

Браво :))))))))

[115] Юрий Зотов © (20.07.04 14:51)

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

Хех... Наверно стар я становлюсь ;) Из всего прочитанного меня задело только неправильное употребление французского языка в извратно отредактированном варианте (Денис (13.07.04 18:22) [54]).

А по теме хочу процитировать:

"Если б мишки
Были б пчелами,
То они бы ни по чем
Ни за что бы ни подумали
Так высОко строить дом..."

На фик не надо мишкам дом на дереве. О!

> Единственный язык который без коментарриев сложно воспринимается(когда
> какой-то большой и сложный кусок программы) - это асм. Тут
> я всеми руками за подробный коментаррий, но таки не на каждой
> строчке, а на той, где действие неясно из контекста.

Немного ностальгии.
До сих пор лежит дома книжка с полностью дизасемблированным и откомментированным ПЗУ от "Спектрум".
Комментарии - сказка! Я иногда их просто для удовольствия читаю на ночь, как роман идут, чес. слово (кто видел - поймет).
Вот на чем надо учиться (в том числе и как комментарии писать)!

Народ!

А что, никто не заметил?

by Denis:

> то касается русского DELPHI , твоя идея кажется, - вот создатель Паскаль - молодец!Взял и создал програмный язык на родном языке, на радость и удобство всем англоязычным.

Если бы так и было, то щас бы мы писали:

фюр i := 1 бис цу 10 махе

А может по-французски как-нибудь писали бы?

Подробный и понятный комментарий! Найти похожие ветки