Модераторы: Nastya, LSD

Поиск:

Ответ в темуСоздание новой темы Создание опроса
> Коментарии в коде 
:(
    Опции темы
 
По какому принципу вы ставите коменты в коде
Чем больше тем лучше [ 14 ]  [31.11%]
Комментарии в коде по XP. [ 5 ]  [11.11%]
По принципу * [ 14 ]  [31.11%]
Вообще не ставлю [ 2 ]  [4.44%]
Как прийдется, в случае ошибк [ 6 ]  [13.33%]
Другой прицип [ 4 ]  [8.89%]
Всего проголосовавших: 45
В этом опросе возможен один вариант ответа
Гости не могут голосовать 
Nastya
Дата 29.8.2007, 17:50 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Комодератор
Сообщений: 1287
Регистрация: 27.3.2002
Где: Мариуполь

Репутация: 0
Всего: 44
Поясняю:

Комментарии в коде по XP. - это http://subscribe.ru/archive/comp.soft.prog...1/28182119.html

По принципу * то же что и Комментарии в коде по XP, только с учетом что UnitTest'ов может не быть. Т.е. комментируются все декларации. Коментарии в телах функций сводятся к минимуму

Добавлено через 3 минуты и 19 секунд
Просьба в своих коментариях уточнять язык на котором пишите


--------------------
Что бы понять рекурсию, надо понять рекурсию

"Профессионал - это человек сделавший все возможные ошибки в очень узкой области". Н.Бор
PM MAIL   Вверх
Mayk
Дата 29.8.2007, 18:17 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


^аВаТаР^ сообщение>>
****


Профиль
Группа: Участник
Сообщений: 2616
Регистрация: 22.5.2005
Где: за границей разум а

Репутация: 2
Всего: 134
Чем меньше тем лучше. 
Цитата(Nastya @  29.8.2007,  21:50 Найти цитируемый пост)

По принципу *

Во-первых, комментарий декларации улучшает навигацию по тексту [нажав на pg up. мне не приходится гадать покинул я ф-цию или нет].
Во-вторых, не верю что  пример кода способен заменить документацию. 

Если какой-то блок кода в ф-ции руки нуждается в комментарии, то предпочитаю вынести этот блок в отдельную функцию. 

Цитата(Nastya @  29.8.2007,  21:50 Найти цитируемый пост)

Просьба в своих коментариях уточнять язык на котором пишите 

c++/java/python.


--------------------
 Здесь был кролик. Но его убили.
Человеки < кроликов, йа считаю.
PM MAIL WWW ICQ   Вверх
JackYF
Дата 29.8.2007, 18:41 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


полуавантюрист
****


Профиль
Группа: Участник
Сообщений: 5814
Регистрация: 28.8.2004
Где: страна тысячи озё р

Репутация: 5
Всего: 162
По принципу *.

С++.


--------------------
Пожаловаться на меня как модератора можно здесь.
PM MAIL Jabber   Вверх
chipset
Дата 29.8.2007, 18:50 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
****


Профиль
Группа: Экс. модератор
Сообщений: 4071
Регистрация: 11.1.2003
Где: Seattle, US

Репутация: 4
Всего: 165
Там где надо.

C++


--------------------
Цитата(Jimi Hendrix)
Well, I stand up next to a mountain
And I chop it down with the edge of my hand
PM MAIL WWW   Вверх
Любитель
Дата 30.8.2007, 00:10 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Программист-романтик
****


Профиль
Группа: Комодератор
Сообщений: 3645
Регистрация: 21.5.2005
Где: Воронеж

Репутация: нет
Всего: 92
Вспомнился случай, как один мой одногруппник на первой курсе сдавал курсовую (маленькую smile ) на Паскале (писалось в принципе на Дельфе - отсюда даблслешовые комменты). Помня любовь преподов к комментам он дошёл до чего-то такого:
Код

var // объявление переменных
    { ... }
    count: integer; // переменная для количества
{ ... }
inc(count); // увеличение count на 1

 smile 


--------------------
http://oryolalex.mybrute.com
PM MAIL ICQ Skype   Вверх
Retro
Дата 30.8.2007, 08:53 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Диалектик
***


Профиль
Группа: Участник Клуба
Сообщений: 1934
Регистрация: 28.6.2005
Где: Киев

Репутация: 6
Всего: 117
Чем больше тем лучше

Плюс, считаю, что очень важен самодокументированный код.


--------------------
Маркетинговые истории
PM MAIL   Вверх
ТоляМБА
Дата 30.8.2007, 09:11 (ссылка) | (голосов:1) Загрузка ... Загрузка ... Быстрая цитата Цитата


Котэ
***


Профиль
Группа: Завсегдатай
Сообщений: 1607
Регистрация: 15.12.2004

Репутация: 1
Всего: 252
Цитата
327878 [ + 12609 − ] [:||||:] approved by DarkRider, 2007-06-16 20:06 
<fishernw> серьёзные мануалы нычне пошли..
// тили-тили
// трали-вали
if (jsLoaded) {
// это дело мне по силе
// откажусь теперь едва ли
} else {
// это мы не проходили
// это нам не задавали
}

С Баш орга.

А если серъёзно, стараюсь каментить переменные и константы и узкие места в проге. Но переменные не все комментирую конечно - например для цикла For переменную i конечно не комментирую, так же стараюсь давать переменным значащие имена или если вызываю ActiveX объекты, то переменные привязанные к ним называю по имени объекта.
PM   Вверх
Guedda
Дата 7.9.2007, 11:51 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Подрывник
****


Профиль
Группа: Завсегдатай
Сообщений: 3137
Регистрация: 27.12.2005
Где: Ростов-на-Дону

Репутация: нет
Всего: 78
Как прийдется, в случае ошибк

php



--------------------
Ll 2
PM MAIL WWW ICQ Skype GTalk   Вверх
Void
Дата 8.9.2007, 10:52 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


λcat.lolcat
****


Профиль
Группа: Участник Клуба
Сообщений: 2206
Регистрация: 16.11.2004
Где: Zürich

Репутация: 2
Всего: 173
По XP.

Юнит-тесты пишу по возможности (да и требуют), в текущем проекте их мало, но до некоторой степени их заменяют doctests.

C, Python.


--------------------
“Coming back to where you started is not the same as never leaving.” — Terry Pratchett
PM MAIL WWW GTalk   Вверх
Nastya
Дата 10.9.2007, 09:19 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Комодератор
Сообщений: 1287
Регистрация: 27.3.2002
Где: Мариуполь

Репутация: 0
Всего: 44
Void, супер. второй живой человек с кем общеюсь, кто юниттесты пишет. А я вот если честно слабо представляю как это можно сделать для GUI приложения :(. 


--------------------
Что бы понять рекурсию, надо понять рекурсию

"Профессионал - это человек сделавший все возможные ошибки в очень узкой области". Н.Бор
PM MAIL   Вверх
Void
Дата 10.9.2007, 14:16 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


λcat.lolcat
****


Профиль
Группа: Участник Клуба
Сообщений: 2206
Регистрация: 16.11.2004
Где: Zürich

Репутация: 2
Всего: 173
Цитата(Nastya @  10.9.2007,  11:19 Найти цитируемый пост)
А я вот если честно слабо представляю как это можно сделать для GUI приложения

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


--------------------
“Coming back to where you started is not the same as never leaving.” — Terry Pratchett
PM MAIL WWW GTalk   Вверх
bilbobagginz
Дата 10.9.2007, 14:22 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Naughtius Maximus
****


Профиль
Группа: Экс. модератор
Сообщений: 8813
Регистрация: 2.3.2004
Где: Israel

Репутация: 3
Всего: 317
c/cpp и pl/py/sh/csh
больше лучше. лишнего не писать.
просто если есть проект с большим кол-вом деталей, не классически структурные системы с прерываниями, параллеллизацией и т.д. - без документирования потом через месяц уже не помнишь что к чему.
а "примерно понимать что делает кусок кода" ... это не серьезно.

всем всех благ.




--------------------
Я ещё не демон. Я только учусь.
PM WWW   Вверх
Ch0bits
Дата 11.9.2007, 12:55 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Python Dev.
****


Профиль
Группа: Завсегдатай
Сообщений: 2124
Регистрация: 21.2.2005
Где: Казань

Репутация: нет
Всего: 62
Пишу обильно, но только по существу. Перед хитрыми алгоритмами пишу полное описание идеи словами.


--------------------
Quizful - новый портал с классными IT тестами!
PM WWW   Вверх
LSD
Дата 15.9.2007, 00:02 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Leprechaun Software Developer
****


Профиль
Группа: Модератор
Сообщений: 15718
Регистрация: 24.3.2004
Где: Dublin

Репутация: 3
Всего: 538
Цитата
Другой прицип

Хороший код - в комментариях не нуждается smile

Добавлено через 1 минуту и 34 секунды
P.S. За исключением интерфейсов, там декларировать контракт обязательно нужно.


--------------------
Disclaimer: this post contains explicit depictions of personal opinion. So, if it sounds sarcastic, don't take it seriously. If it sounds dangerous, do not try this at home or at all. And if it offends you, just don't read it.
PM MAIL WWW   Вверх
S.A.G.
Дата 24.9.2007, 22:49 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


не эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1339
Регистрация: 20.7.2006
Где: in ad equate

Репутация: -1
Всего: 19
Комментарии нужны, но лишнего не ставлю. smile

Ах да, C/C++


--------------------
Вот она задачка: спасти себя от себя самого © Cube
Sometimes good people do evil things © A Simple Plan
PM   Вверх
Ответ в темуСоздание новой темы Создание опроса
Правила форума "Опросы"
Smartov
Nastya

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

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


С уважением, Smartov, Nastya.
 
0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема | Опросы | Следующая тема »

Подписаться на тему | Подписка на этот форум | Скачать/Распечатать тему


 




[ Время генерации скрипта: 0.0753 ]   [ Использовано запросов: 24 ]   [ GZIP включён ]


Реклама на сайте     Информационное спонсорство

 
 По вопросам размещения рекламы пишите на vladimir(sobaka)vingrad.ru
Отказ от ответственности     Powered by Invision Power Board(R) 1.3 © 2003  IPS, Inc.