Forth и другие саморасширяющиеся системы программирования Locations of visitors to this page
Текущее время: Вс дек 16, 2018 11:53

...
Google Search
Forth-FAQ Spy Grafic

Часовой пояс: UTC + 3 часа [ Летнее время ]




Начать новую тему Ответить на тему  [ Сообщений: 17 ]  На страницу 1, 2  След.
Автор Сообщение
 Заголовок сообщения: Стиль кода и комментирование
СообщениеДобавлено: Сб дек 20, 2008 00:03 
Не в сети
Аватара пользователя

Зарегистрирован: Вт мар 20, 2007 23:39
Сообщения: 1256
Благодарил (а): 3 раз.
Поблагодарили: 18 раз.
Предлагаю в обязательном порядке включить в стандарт правила оформления кода, стековых и обычных комментариев, а также обозначения параметров в стековых комментариях. Отталкиваться думаю можно от книг Броуди и опыта.

_________________
Cтоимость сопровождения программного обеспечения пропорциональна квадрату творческих способностей программиста.
Роберт Д. Блисc


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Сб дек 20, 2008 00:07 
Не в сети
Administrator
Administrator
Аватара пользователя

Зарегистрирован: Вт май 02, 2006 13:19
Сообщения: 3565
Откуда: St.Petersburg
Благодарил (а): 4 раз.
Поблагодарили: 72 раз.
Может, все же не правила, а рекомендации по оформлению кода?
А то ведь иногда и на красный свет приходится улицу перебегать.

_________________
С уважением, WingLion
Forth-CPU . RuF09WE
Мой Форт
Отсутствие бана это не заслуга юзера, а недоработка модератора (с)


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Сб дек 20, 2008 00:53 
Не в сети
Аватара пользователя

Зарегистрирован: Вт мар 20, 2007 23:39
Сообщения: 1256
Благодарил (а): 3 раз.
Поблагодарили: 18 раз.
Да, скорее рекомендации. Если ситуация позволяет сделать что-то более эффективно - то так и надо делать.

_________________
Cтоимость сопровождения программного обеспечения пропорциональна квадрату творческих способностей программиста.
Роберт Д. Блисc


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Сб дек 20, 2008 20:17 
Не в сети

Зарегистрирован: Ср сен 13, 2006 10:06
Сообщения: 636
Откуда: Омск
Благодарил (а): 0 раз.
Поблагодарили: 3 раз.
Главное не драться, по маленьку и придумаем

_________________
Меня нет, не будет и не было.


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Пн дек 22, 2008 14:12 
Не в сети
Аватара пользователя

Зарегистрирован: Вт сен 11, 2007 11:07
Сообщения: 187
Благодарил (а): 0 раз.
Поблагодарили: 1 раз.
неплохо бы эти рекомендации сделать достаточно формальными, чтобы была возможность
реализовать подключаемую проверку lint/typecheck


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Пн дек 22, 2008 15:12 
Не в сети
Аватара пользователя

Зарегистрирован: Вт мар 20, 2007 23:39
Сообщения: 1256
Благодарил (а): 3 раз.
Поблагодарили: 18 раз.
garbler писал(а):
чтобы была возможность реализовать подключаемую проверку lint/typecheck

А можно теперь повторить тоже самое по-русски?

_________________
Cтоимость сопровождения программного обеспечения пропорциональна квадрату творческих способностей программиста.
Роберт Д. Блисc


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Пн дек 22, 2008 16:57 
Не в сети

Зарегистрирован: Сб май 06, 2006 12:01
Сообщения: 959
Откуда: Украина, Харьков
Благодарил (а): 2 раз.
Поблагодарили: 7 раз.
М.И. Болски Справочник. Язык программирования Си М., Радио и связь. 1988г писал(а):
Верификатор (программа семантического контроля) lint обеспечивает строгую проверку типов и выявляет многие конструкции, ухудшающие мобильность программ, написанных на языке Си.

_________________
With best wishes, in4.


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Пн дек 22, 2008 23:42 
Не в сети
Аватара пользователя

Зарегистрирован: Вт мар 20, 2007 23:39
Сообщения: 1256
Благодарил (а): 3 раз.
Поблагодарили: 18 раз.
in4 писал(а):
М.И. Болски Справочник. Язык программирования Си М., Радио и связь. 1988г писал(а):Верификатор (программа семантического контроля) lint обеспечивает строгую проверку типов и выявляет многие конструкции, ухудшающие мобильность программ, написанных на языке Си.

Ясно, спасибо.

_________________
Cтоимость сопровождения программного обеспечения пропорциональна квадрату творческих способностей программиста.
Роберт Д. Блисc


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Пт янв 30, 2009 18:41 
Не в сети

Зарегистрирован: Ср сен 13, 2006 10:06
Сообщения: 636
Откуда: Омск
Благодарил (а): 0 раз.
Поблагодарили: 3 раз.
Я вот думаю(наверно), может подвести к стандарту не только стековые комментарии, но и формирования слов. Хотя тут все и не предугадаешь.

_________________
Меня нет, не будет и не было.


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Сб янв 31, 2009 17:44 
Не в сети

Зарегистрирован: Сб май 06, 2006 12:01
Сообщения: 959
Откуда: Украина, Харьков
Благодарил (а): 2 раз.
Поблагодарили: 7 раз.
Стандартно можно комментировать только имя (происхождение, мнемоника) и параметры слова.
Хорошие комментарии комментируют разным, лучше всего подходящим к данной ситуации и лучше запоминающимся способом. Еще важно, чтоб комментарий был покороче (из подходящих коротких синонимов и без лишней воды), хотя и тут возможны варианты "углубления". Размышления подводят к мысли, что должно быть несколько уровней комментирования. На очень подробном - можно даже использовать частично автоматическое комментирование (особенно редко встречающихся слов). Уровни комментирования должен бы скрывать используемый редактор... ;)
Что еще важно - и мало где есть - должны быть описани идеи используемого алгоритма - т.е. не что делаем, а почему. И почему были выбраны именно эти решения. Наличие такого комментария может снизить необходимость подробно комментировать остальное - многое будет и так понятно!
Также желательно использовать одинаковые термины внутри связной части текста. У кого-то из классиков прочитал, что локальная связность важнее глобальной. Т.е. одна либа или файл может отличаться стилем комментирования/оформления от остальных. И важно, чтобы внутри этой либы все было тесно согласовано, даже если это отличается от окружающих либ одного проекта.
Можно еще вставлять стековые картинки внутри циклов, чтоб можно было не анализируя подробно увидеть, что там происходит.
В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста. :)

_________________
With best wishes, in4.


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Сб янв 31, 2009 21:04 
Не в сети

Зарегистрирован: Ср сен 13, 2006 10:06
Сообщения: 636
Откуда: Омск
Благодарил (а): 0 раз.
Поблагодарили: 3 раз.
Я же не о стековых коментах говорю, а о составлении слов, вернее имен к словам.

_________________
Меня нет, не будет и не было.


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Сб янв 31, 2009 21:56 
Не в сети

Зарегистрирован: Вт май 09, 2006 12:31
Сообщения: 3438
Благодарил (а): 5 раз.
Поблагодарили: 16 раз.
Цитата:
В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста.
СВОДИТЬ К НУЛЮ!
понимания требует не текст а алгоритм.

_________________
понимаю некоторую бестолковость некоторых вопросов


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Вс фев 01, 2009 13:07 
Не в сети

Зарегистрирован: Пн окт 15, 2007 17:24
Сообщения: 164
Откуда: Бийск
Благодарил (а): 0 раз.
Поблагодарили: 2 раз.
вопрос писал(а):
Цитата:
В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста.
СВОДИТЬ К НУЛЮ!
понимания требует не текст а алгоритм.

тогда текст вообще можно не показывать?

_________________
And so forth ...


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Вс фев 01, 2009 14:09 
Не в сети

Зарегистрирован: Сб май 06, 2006 12:01
Сообщения: 959
Откуда: Украина, Харьков
Благодарил (а): 2 раз.
Поблагодарили: 7 раз.
Pretorian писал(а):
Я же не о стековых коментах говорю, а о составлении слов, вернее имен к словам.
Тогда - предложения Броуди.
Префиксы-суффиксы... ;)
Но мне чего-то символов не хватает для выражения всего многообразия...
И хотелось бы стандарт предлагать после составления "сети понятий" - еще не сделанной (не наблюдаемой мною в открытом доступе) сети связей значений слов...

_________________
With best wishes, in4.


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения:
СообщениеДобавлено: Вс фев 01, 2009 14:21 
Не в сети
Administrator
Administrator
Аватара пользователя

Зарегистрирован: Вт май 02, 2006 13:19
Сообщения: 3565
Откуда: St.Petersburg
Благодарил (а): 4 раз.
Поблагодарили: 72 раз.
Что-то у меня стойкое такое впечатление, что стандарт на комментарии будет иметь примерно такой же смысл,
как стандарт на рисование "мадонны с младенцем".

Программирование, а вместе с ним и комментирование, подпадает под понятие "творчество" и "искусство".
А введение на творчество и искусство стандартов как-то не сильно разумно, а?
Стандарт на краски, кисти, холсты, в конце концов, еще куда ни шло, но стандарт на "кривизну носа мадонны"... :shock:

_________________
С уважением, WingLion
Forth-CPU . RuF09WE
Мой Форт
Отсутствие бана это не заслуга юзера, а недоработка модератора (с)


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
Показать сообщения за:  Поле сортировки  
Начать новую тему Ответить на тему  [ Сообщений: 17 ]  На страницу 1, 2  След.

Часовой пояс: UTC + 3 часа [ Летнее время ]


Кто сейчас на конференции

Сейчас этот форум просматривают: нет зарегистрированных пользователей и гости: 4


Вы не можете начинать темы
Вы можете отвечать на сообщения
Вы не можете редактировать свои сообщения
Вы не можете удалять свои сообщения
Вы не можете добавлять вложения

cron
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group
phpBB сборка от FladeX // Русская поддержка phpBB