Автор |
Сообщение |
|
|
Заголовок сообщения: |
|
|
|
in4 писал(а): А комментирование исходников примеров из Стандарта
Во-во, уже с большой буквы
[quote="in4"]А комментирование исходников примеров из Стандарта [/quote]
Во-во, уже с большой буквы :))
|
|
|
|
Добавлено: Вс фев 01, 2009 15:38 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Предложения по именованию слов - может, чуть расширив предложения Броуди - сделать можно. Кстати, я попробовал - получается очень неплохо! Если это применять шире (в исходниках примеров из Стандарта, например), то люди постепенно привыкнут... А реально текст получается короче!
А комментирование исходников примеров из Стандарта можно сделать образцом. Просто чтоб заполнить пустоту и показать пример, как можно делать!
Предложения по именованию слов - может, чуть расширив предложения Броуди - сделать можно. :) Кстати, я попробовал - получается очень неплохо! Если это применять шире (в исходниках примеров из Стандарта, например), то люди постепенно привыкнут... ;) А реально текст получается [b]короче[/b]!
А комментирование исходников примеров из Стандарта можно сделать образцом. Просто чтоб заполнить пустоту и показать пример, как можно делать!
|
|
|
|
Добавлено: Вс фев 01, 2009 14:56 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Что-то у меня стойкое такое впечатление, что стандарт на комментарии будет иметь примерно такой же смысл,
как стандарт на рисование "мадонны с младенцем".
Программирование, а вместе с ним и комментирование, подпадает под понятие "творчество" и "искусство".
А введение на творчество и искусство стандартов как-то не сильно разумно, а?
Стандарт на краски, кисти, холсты, в конце концов, еще куда ни шло, но стандарт на "кривизну носа мадонны"...
Что-то у меня стойкое такое впечатление, что стандарт на комментарии будет иметь примерно такой же смысл,
как стандарт на рисование "мадонны с младенцем".
Программирование, а вместе с ним и комментирование, подпадает под понятие "творчество" и "искусство".
А введение на творчество и искусство стандартов как-то не сильно разумно, а?
Стандарт на краски, кисти, холсты, в конце концов, еще куда ни шло, но стандарт на "кривизну носа мадонны"... :shock:
|
|
|
|
Добавлено: Вс фев 01, 2009 14:21 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Pretorian писал(а): Я же не о стековых коментах говорю, а о составлении слов, вернее имен к словам. Тогда - предложения Броуди.
Префиксы-суффиксы...
Но мне чего-то символов не хватает для выражения всего многообразия...
И хотелось бы стандарт предлагать после составления "сети понятий" - еще не сделанной (не наблюдаемой мною в открытом доступе) сети связей значений слов...
[quote="Pretorian"]Я же не о стековых коментах говорю, а о составлении слов, вернее имен к словам.[/quote]Тогда - предложения Броуди.
Префиксы-суффиксы... ;)
Но мне чего-то символов не хватает для выражения всего многообразия...
И хотелось бы стандарт предлагать [b]после[/b] составления "сети понятий" - еще не сделанной (не наблюдаемой мною в открытом доступе) сети связей значений слов...
|
|
|
|
Добавлено: Вс фев 01, 2009 14:09 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
вопрос писал(а): Цитата: В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста. СВОДИТЬ К НУЛЮ! понимания требует не текст а алгоритм.
тогда текст вообще можно не показывать?
[quote="вопрос"][quote]В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста. [/quote] СВОДИТЬ К НУЛЮ! понимания требует не текст а алгоритм.[/quote]
тогда текст вообще можно не показывать?
|
|
|
|
Добавлено: Вс фев 01, 2009 13:07 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Цитата: В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста. СВОДИТЬ К НУЛЮ!
понимания требует не текст а алгоритм.
[quote]В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста. [/quote] СВОДИТЬ К НУЛЮ!
понимания требует не текст а алгоритм.
|
|
|
|
Добавлено: Сб янв 31, 2009 21:56 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Я же не о стековых коментах говорю, а о составлении слов, вернее имен к словам.
Я же не о стековых коментах говорю, а о составлении слов, вернее имен к словам.
|
|
|
|
Добавлено: Сб янв 31, 2009 21:04 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Стандартно можно комментировать только имя (происхождение, мнемоника) и параметры слова.
Хорошие комментарии комментируют разным, лучше всего подходящим к данной ситуации и лучше запоминающимся способом. Еще важно, чтоб комментарий был покороче (из подходящих коротких синонимов и без лишней воды), хотя и тут возможны варианты "углубления". Размышления подводят к мысли, что должно быть несколько уровней комментирования. На очень подробном - можно даже использовать частично автоматическое комментирование (особенно редко встречающихся слов). Уровни комментирования должен бы скрывать используемый редактор...
Что еще важно - и мало где есть - должны быть описани идеи используемого алгоритма - т.е. не что делаем, а почему. И почему были выбраны именно эти решения. Наличие такого комментария может снизить необходимость подробно комментировать остальное - многое будет и так понятно!
Также желательно использовать одинаковые термины внутри связной части текста. У кого-то из классиков прочитал, что локальная связность важнее глобальной. Т.е. одна либа или файл может отличаться стилем комментирования/оформления от остальных. И важно, чтобы внутри этой либы все было тесно согласовано, даже если это отличается от окружающих либ одного проекта.
Можно еще вставлять стековые картинки внутри циклов, чтоб можно было не анализируя подробно увидеть, что там происходит.
В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста.
Стандартно можно комментировать только имя (происхождение, мнемоника) и параметры слова.
Хорошие комментарии комментируют разным, лучше всего подходящим к данной ситуации и лучше запоминающимся способом. Еще важно, чтоб комментарий был покороче (из подходящих коротких синонимов и без лишней воды), хотя и тут возможны варианты "углубления". Размышления подводят к мысли, что должно быть несколько уровней комментирования. На очень подробном - можно даже использовать частично автоматическое комментирование (особенно редко встречающихся слов). Уровни комментирования должен бы скрывать используемый редактор... ;)
Что еще важно - и мало где есть - должны быть описани [b]идеи[/b] используемого алгоритма - т.е. не [b]что[/b] делаем, а [b]почему[/b]. И [b]почему[/b] были выбраны именно эти решения. Наличие такого комментария может снизить необходимость подробно комментировать остальное - многое будет и так понятно!
Также желательно использовать одинаковые термины внутри связной части текста. У кого-то из классиков прочитал, что [i]локальная связность важнее глобальной[/i]. Т.е. одна либа или файл может отличаться стилем комментирования/оформления от остальных. И важно, чтобы внутри этой либы все было тесно согласовано, даже если это отличается от окружающих либ одного проекта.
Можно еще вставлять стековые картинки внутри циклов, чтоб можно было не анализируя подробно увидеть, что там происходит.
В общем, хороший комментарий должен снижать количество умственных усилий, требуемых для понимания текста. :)
|
|
|
|
Добавлено: Сб янв 31, 2009 17:44 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Я вот думаю(наверно), может подвести к стандарту не только стековые комментарии, но и формирования слов. Хотя тут все и не предугадаешь.
Я вот думаю(наверно), может подвести к стандарту не только стековые комментарии, но и формирования слов. Хотя тут все и не предугадаешь.
|
|
|
|
Добавлено: Пт янв 30, 2009 18:41 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
in4 писал(а): М.И. Болски Справочник. Язык программирования Си М., Радио и связь. 1988г писал(а):Верификатор (программа семантического контроля) lint обеспечивает строгую проверку типов и выявляет многие конструкции, ухудшающие мобильность программ, написанных на языке Си.
Ясно, спасибо.
[quote="in4"]М.И. Болски Справочник. Язык программирования Си М., Радио и связь. 1988г писал(а):Верификатор (программа семантического контроля) lint обеспечивает строгую проверку типов и выявляет многие конструкции, ухудшающие мобильность программ, написанных на языке Си.[/quote]
Ясно, спасибо.
|
|
|
|
Добавлено: Пн дек 22, 2008 23:42 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
М.И. Болски Справочник. Язык программирования Си М., Радио и связь. 1988г писал(а): Верификатор (программа семантического контроля) lint обеспечивает строгую проверку типов и выявляет многие конструкции, ухудшающие мобильность программ, написанных на языке Си.
[quote="М.И. Болски Справочник. Язык программирования Си М., Радио и связь. 1988г"]Верификатор (программа семантического контроля) [b]lint[/b] обеспечивает строгую проверку типов и выявляет многие конструкции, ухудшающие мобильность программ, написанных на языке Си.[/quote]
|
|
|
|
Добавлено: Пн дек 22, 2008 16:57 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
garbler писал(а): чтобы была возможность реализовать подключаемую проверку lint/typecheck
А можно теперь повторить тоже самое по-русски?
[quote="garbler"] чтобы была возможность реализовать подключаемую проверку lint/typecheck[/quote]
А можно теперь повторить тоже самое по-русски?
|
|
|
|
Добавлено: Пн дек 22, 2008 15:12 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
неплохо бы эти рекомендации сделать достаточно формальными, чтобы была возможность
реализовать подключаемую проверку lint/typecheck
неплохо бы эти рекомендации сделать достаточно формальными, чтобы была возможность
реализовать подключаемую проверку lint/typecheck
|
|
|
|
Добавлено: Пн дек 22, 2008 14:12 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Главное не драться, по маленьку и придумаем
Главное не драться, по маленьку и придумаем
|
|
|
|
Добавлено: Сб дек 20, 2008 20:17 |
|
|
|
|
|
Заголовок сообщения: |
|
|
|
Да, скорее рекомендации. Если ситуация позволяет сделать что-то более эффективно - то так и надо делать.
Да, скорее рекомендации. Если ситуация позволяет сделать что-то более эффективно - то так и надо делать.
|
|
|
|
Добавлено: Сб дек 20, 2008 00:53 |
|
|
|
|