Скачать: CL | DM;

Как часто вы используете комментарии в программах?   Найти похожие ветки 

← →
MAN-IN-RED ©   (2003-01-19 15:51) [0]

Я, например, почти после каждой строки кода :)
?

---

← →
Юрий Зотов ©   (2003-01-19 15:55) [1]

В особо тонких или сложных местах. В остальных стараюсь писать самокомментируемый код.

---

← →
Anatoly Podgoretsky ©   (2003-01-19 15:56) [2]

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

---

← →
McSimm ©   (2003-01-19 16:05) [3]

Благодаря опыту заранее знаю какие именно места вызовут у меня в будущем затруднения в разборе программы, там и пишу.
Писал бы больше, но не хватает самодисциплины и времени.

В местах кода, с которым придется работать коллегам пишу всегда.

---

← →
Cr@sh ©   (2003-01-19 16:12) [4]

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

---

← →
Ketmar ©   (2003-01-19 16:18) [5]

>Cr@sh © (19.01.03 16:12)
"comments are for beginners" (c) pascal aka Niclaus Beizert %-)

очень редко. в основном только там, где использую какой-нибудь "финт ушами" или процедура имеет неочевидные side effects.
плюс - заголовок модуля.
в последнее время еще к каждой процедуре (если не лень %-) добавляю стандартный заголовок: имя и краткое описание. эти комменты потом у меня отдельная софтина вытаскивает и делает такой себе маленький справочник.

Satanas Nobiscum! 19-Jan-XXXVIII A.S.

---

← →
Сатир ©   (2003-01-19 16:53) [6]

2Ketmar © (19.01.03 16:18)
напоминает заморочку из Жабы. Там такая софтина называлась javadoc, если мне не изменяет память...

---

← →
Ketmar ©   (2003-01-19 17:01) [7]

>Сатир © (19.01.03 16:53)
да такие фичи для каждого языка есть, имхо.

Satanas Nobiscum! 19-Jan-XXXVIII A.S.

---

← →
Mystic ©   (2003-01-19 17:12) [8]

То же, что и Юрий Зотов, + стараюсь вести TODO лист.

---

← →
MAN-IN-RED ©   (2003-01-19 17:14) [9]

Мда, видимо у меня это вошло в привычку, сам не знаю, почему комментирую весь код :) Хотя красиво смотрится, слева столб кода, справа столб текста, никому не нужного, исходники своих программ я никому не даю…

---

← →
Anatoly Podgoretsky ©   (2003-01-19 17:30) [10]

MAN-IN-RED © (19.01.03 17:14)
Стыдно что ли? Или они настолько ценны?

---

← →
MAN-In-RED ©   (2003-01-19 17:42) [11]

> Anatoly Podgoretsky © (19.01.03 17:30)

Нет, знаете не стыдно :) Скорей второе…

---

← →
Big_Rom ©   (2003-01-19 17:50) [12]

тогда лучше не комментировать, а вдруг всеже камунибудь достанутся
хоть помучается :))

а по-моему, лучше комментировать,если в привычку вошло.

---

← →
Desdechado ©   (2003-01-19 18:03) [13]

а у меня комментарии
1. на модуль
2. к каждой функции
3. к глобальным переменным и свойствам классов
4. к смысловым совокупностям кода внутри функций (каждые 10-20 строк)
5. к особым хитростям

---

← →
DiamondShark ©   (2003-01-19 18:41) [14]

Комментарии изначально предназначались для размещения директив компилятора. Потом некоторые забывчивые (но находчивые) программисты придумали использовать их для всяких заметок.

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

---

← →
Ketmar ©   (2003-01-19 18:53) [15]

>DiamondShark © (19.01.03 18:41)
%-)

Satanas Nobiscum! 19-Jan-XXXVIII A.S.

---

← →
kaif ©   (2003-01-19 19:51) [16]

К сожалению, снабжаю комментариями текст только если вернулся к нему с целью "причесать". Хотя и считаю, что комментарии вещь обязательная в хитрых местах...

---

← →
Карлсон ©   (2003-01-19 20:23) [17]

если и делаю комментарии, то только обозначаю начало и конец выполнения определенных действий программы.
например {Проверка цветовой гаммы} {/Проверка цветовой гаммы}

---

← →
kostya2000 ©   (2003-01-19 20:32) [18]

Я если пишу что то сложное, большое. и то, выделяю часть кода, которую я _больше_ трогать не буду и там его и ставлю!

---

← →
Sha ©   (2003-01-19 22:19) [19]

Только заголовок и разные тонкости. Раньше комментировал больше, в основном для других.

---

← →
Jeer ©   (2003-01-19 22:34) [20]

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

На Дельфи использую коментарий, в основном, для переменных.
Текст пишется так, что читаем и спустя годы.

---

← →
Opryshok ©   (2003-01-19 23:16) [21]

Я пишу в конце большого блока
if (...)
{



}//end of ...

или TODO листы.

---

← →
gsu ©   (2003-01-19 23:19) [22]

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

---

← →
vuk ©   (2003-01-19 23:19) [23]

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

---

← →
Opryshok ©   (2003-01-19 23:22) [24]

> gsu
to-do тоесть то, что нужно сделать
формат таков:
//TODO|DONE [n] [-o<owner>] [-c<category>] : <to-do item text> */

The word TODO is changed to DONE to mark an item as completed or checked.

Where:

n is a priority that can be set to a number from 1 (highest) to 5 (lowest). Setting n to 0 means assign no priority. It is optional but must be specified right after the TODO or DONE keyword.
TODO is a keyword that indicates a to-do list item. When the item is completed, changes to DONE. Case is not important.
DONE indicates a completed to-do item. Replaces the word TODO when you check an item in the to-do list. Case is not important.
-o owner is the name of the person or group responsible for the item. It may contain spaces and is optional.

-c category is the type of item, such as a UI task. It may contain spaces and is optional.

посмотреть: (View->To-do List)

---

← →
gsu ©   (2003-01-20 00:28) [25]

thank yoy

---

← →
gsu ©   (2003-01-20 00:28) [26]

thank you

---

← →
Странник ©   (2003-01-20 02:41) [27]

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

---

← →
Кот Бегемот ©   (2003-01-20 09:24) [28]

begin
// На всякий случай блокируем форму
Enabled:=false;
// Запрещенная кнопка задействована в таймере - статус Shutdown
(Sender as TButton).Enabled:=false;
// Предупредить юзеров об отключении - а нифига - пускай это делается на клиенте - после получения USER_KILL
// Отключить всех юзеров - послать USER_KILL
Data.UsersMsg4All(USER_KILL);
// Ждем 10 секунд - а потом гасим сервер - пошли все нахрен
// Т.е. надо подождать пока все юзеры ДОБРОВОЛЬНО не отконектятся
// Например раз в секунду делать Rescan и смотреть на кол-во оставшихся :)
// Если никого нету - то можно раньше чем через 10 секунд
Data.StartShutdown();
// Фактически стартуем по таймеру
Timer.Enabled := true;
end;

---

← →
Думкин ©   (2003-01-20 09:35) [29]

Использую в разделе implementation.
Не всегда - в основном для свойств.
И если проект крутится в команде и возможно пойдет в архив - то комментирую чаще и в основном после окончания кодинга.

---

← →
Дремучий ©   (2003-01-20 09:52) [30]

> McSimm © (19.01.03 16:05)

у меня аналогичная с тобой ситуация :))))

---

← →
Думкин ©   (2003-01-20 09:55) [31]

> Думкин © (20.01.03 09:35)
> Использую в разделе implementation.

Сорри - в interface

---

← →
Ru ©   (2003-01-20 10:15) [32]

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

---

← →
Mirovodin ©   (2003-01-20 10:31) [33]

а) к каждым процедурам/функциям. Что делает эта проц-ра, описание параметров. Если это бизнес логика сложно будет вспомнить что делает эта проц-ра/функция без анализа кода.
б) глобальные переменные - ВСЕГДА.
в) утилитные модули полностью описываю. Т.к. пользуюсь не один я.

---

← →
Anatoly Podgoretsky ©   (2003-01-20 11:03) [34]

Трезвая голова это все что нужно, она сразу решит надо ли тут коментарий или нет. Отсутствиее не поможет и с комментраиями.

---

← →
Думкин ©   (2003-01-20 11:16) [35]

> Anatoly Podgoretsky © (20.01.03 11:03)
> Трезвая голова это все что нужно

А в инете нигде такое чудо скачать нельзя? %-)

---

← →
gsu ©   (2003-01-20 11:17) [36]

скачай пособие: "как стать трезвенником за три сеанса" (-:|~

---

← →
Anatoly Podgoretsky ©   (2003-01-20 11:26) [37]

Головы пока не качаются, Under Construction

---

← →
Игорь Шевченко ©   (2003-01-20 11:59) [38]

Комментарии пишу практически всегда, особенно в заголовках. Не напишешь комментарий - коллега потом задергает с просьбой объяснить, как проести очередную модификацию. Экономьте время свое время, господа, одних самодокументируемых идентификаторов недостаточно. (Всегда найдется человек, который воспримет имя самодокументируемого идентификатора не так, как того хотел автор).

---

← →
Кот Бегемот ©   (2003-01-20 12:13) [39]

2Игорь Шевченко © (20.01.03 11:59)
Я в тебе не разочаровался :)))

---

← →
Слесарь Матерящийся ©   (2003-01-20 12:14) [40]

А я пишу подробные комментарии только для себя. Для коллег их специально удаляю :o) Чтобы ручки шаловливые не шастали где попало...

---

Страницы: 1 2 вся ветка

Скачать: CL | DM;



Память: 0.54 MB
Время: 0.012 c