Форум программистов
 

Восстановите пароль или Зарегистрируйтесь на форуме, о проблемах и с заказом рекламы пишите сюда - alarforum@yandex.ru, проверяйте папку спам!

Вернуться   Форум программистов > IT форум > Общие вопросы по программированию, компьютерный форум
Регистрация

Восстановить пароль
Повторная активизация e-mail

Купить рекламу на форуме - 42 тыс руб за месяц

Ответ
 
Опции темы Поиск в этой теме
Старый 03.01.2012, 01:07   #21
Пепел Феникса
Старожил
 
Аватар для Пепел Феникса
 
Регистрация: 28.01.2009
Сообщений: 21,000
По умолчанию

код который практически не нуждается в комментариях.
(хорошие имена функций/классов/переменных/аргументов, не громоздкий код(строки не должны быть огромны и перегружены смыслом)
Хорошо поставленный вопрос это уже половина ответа. | Каков вопрос, таков ответ.
Программа делает то что написал программист, а не то что он хотел.
Функции/утилиты ждут в параметрах то что им надо, а не то что вы хотите.
Пепел Феникса вне форума Ответить с цитированием
Старый 03.01.2012, 01:28   #22
Bustle
Interdicted
Участник клуба
 
Аватар для Bustle
 
Регистрация: 25.11.2010
Сообщений: 1,194
По умолчанию

Элементарное документирования, имхо, нужно. Особенно когда количество строк будет больше за несколько тысяч.
Love writing code and I am really passionate about it
Bustle вне форума Ответить с цитированием
Старый 03.01.2012, 01:35   #23
Пепел Феникса
Старожил
 
Аватар для Пепел Феникса
 
Регистрация: 28.01.2009
Сообщений: 21,000
По умолчанию

но при хорошем коде отнюдь не везде.
например LoadFromFile(string) не сильно нуждется в документации.
но может быть нужно разьяснение результатов(например -1 для CreateFile обязательно) или же насчет исключений.
Хорошо поставленный вопрос это уже половина ответа. | Каков вопрос, таков ответ.
Программа делает то что написал программист, а не то что он хотел.
Функции/утилиты ждут в параметрах то что им надо, а не то что вы хотите.
Пепел Феникса вне форума Ответить с цитированием
Старый 03.01.2012, 07:56   #24
Utkin
Старожил
 
Аватар для Utkin
 
Регистрация: 04.02.2009
Сообщений: 18,136
По умолчанию

Цитата:
например LoadFromFile(string) не сильно нуждется в документации.
Нуждается. Вы загружаете файл, но какой? Настройки, данные, локализация? Что если Вы работаете с более чем одним файлом? Комментируют не строки программы, комментируют алгоритм выраженный в данных строках. Даже i++ нуждается в комментарии. Недостаток Вашего подхода описан Вами в посте 19.
Маньяк-самоучка
Utkin появился в результате деления на нуль.
Осторожно! Альтернативная логика
Utkin вне форума Ответить с цитированием
Старый 03.01.2012, 10:47   #25
anyx
Форумчанин
 
Регистрация: 10.09.2009
Сообщений: 352
По умолчанию

Цитата:
Сообщение от Bustle Посмотреть сообщение
Табуляция 4 пробельных символа (именно пробельных символа, а не знак табуляции)
Господи, а это ещё зачем? Табуляцию табом нужно делать! Ведь у программиста в его среде разработки отображение табуляции настроено так, как ему нравится. У кого 4 пробела, а у кого-то 2 или 8. А делая отступы пробелами вы заставляете другого программиста принимать ваши правила

Цитата:
Сообщение от ImmortalAlexSan Посмотреть сообщение
1. Параметры функции именую, начиная с "p" : pParameter и т.д.
2. Внутренние переменые функций именую, начиная с "_" _Data и т.д.
Цитата:
Сообщение от Пепел Феникса Посмотреть сообщение
С++/C#
2)у параметров у методов обычно ставлю нижнее подчеркивание, но не всегда, а обычно только тогда когда конфликт с именем поля(причем для списка инициализации)
Предварять исходное имя какими-то символами не есть хорошо. По идее система типов языка должна позволять обходиться вообще без доп. символов (Haskell), но если это не так (C/C++), то доп. символы я всегда ставлю после идентификатора: String_t (тип в Си, в таком случае String = String_t*, т.к. в основном используется указатель, а не структура), width_ (параметр функции или локальная переменная в Cи/C++, если он перекрывает поле класса или параметр соответственно), filename_m (приватное поле класса)

Предварять имя плохо, т.к. помня имя вы можете не вспомнить префикс, тогда IDE вам ничем не поможет - по Ctrl+Space имя выдаётся, если вы набрали его начало, но не середину (во всех IDE, в которых я работал)

Цитата:
Сообщение от Пепел Феникса Посмотреть сообщение
С++/C#
Делфи:
2)классы как положенно с Т, предрекая имя класса префиксом
3)поля предрекаю F<имя>
Да, в дельфи никак без этого из-за нечувствительного к регистру символов компилятора

Цитата:
Сообщение от ImmortalAlexSan Посмотреть сообщение
Стив Макконел "Совершенный Код" несколько изданий.
Поддерживаю, отличная книга. Автор рассмотрел практически все аспекты программирования, ведущие к ошибкам, и показал решения даже на языках, которые к подобным ошибкам предрасположены

Последний раз редактировалось anyx; 03.01.2012 в 11:57.
anyx вне форума Ответить с цитированием
Старый 03.01.2012, 12:17   #26
Пепел Феникса
Старожил
 
Аватар для Пепел Феникса
 
Регистрация: 28.01.2009
Сообщений: 21,000
По умолчанию

Цитата:
Нуждается. Вы загружаете файл, но какой? Настройки, данные, локализация? Что если Вы работаете с более чем одним файлом?
учитывая что я за ООП, то этот метод будет частью класса.
Цитата:
Недостаток Вашего подхода описан Вами в посте 19.
дык там про "пьяный" код.
и про самодокументируемый.
Цитата:
Даже i++ нуждается в комментарии.
перебор с комментами тоже плохо.
все зависит от того как организовать код.

если повторяющиеся блоки вынести в функции, то можно сделать так что код можно просто читать и без комментов.
Хорошо поставленный вопрос это уже половина ответа. | Каков вопрос, таков ответ.
Программа делает то что написал программист, а не то что он хотел.
Функции/утилиты ждут в параметрах то что им надо, а не то что вы хотите.
Пепел Феникса вне форума Ответить с цитированием
Старый 03.01.2012, 12:58   #27
Alex11223
Старожил
 
Аватар для Alex11223
 
Регистрация: 12.01.2011
Сообщений: 19,500
По умолчанию

Цитата:
Господи, а это ещё зачем? Табуляцию табом нужно делать!
Затем, что это холиварная тема. В любом сообществе, форуме и т.п. на тему программирования бывают холивары на тему пробелы vs табы.

Пример: http://habrahabr.ru/tag/табуляция/ (по тегам еще штук 10 тем), http://stackoverflow.com/search?q=ta...&submit=search
Ушел с форума, https://www.programmersforum.rocks, alex.pantec@gmail.com, https://github.com/AlexP11223
ЛС отключены Аларом.
Alex11223 вне форума Ответить с цитированием
Старый 03.01.2012, 13:16   #28
Utkin
Старожил
 
Аватар для Utkin
 
Регистрация: 04.02.2009
Сообщений: 18,136
По умолчанию

Цитата:
дык там про "пьяный" код.
и про самодокументируемый.
Дык и я про тоже самое. Не важно в каком виде код был писан. Алгоритм его работы должен быть ясен всегда. При определенной методике это возможно.
Маньяк-самоучка
Utkin появился в результате деления на нуль.
Осторожно! Альтернативная логика
Utkin вне форума Ответить с цитированием
Старый 03.01.2012, 13:27   #29
MaTBeu
Eclipse Foundation
Старожил
 
Аватар для MaTBeu
 
Регистрация: 19.09.2007
Сообщений: 2,619
По умолчанию

Цитата:
Сообщение от Utkin Посмотреть сообщение
1. Практически каждая строка должна иметь поясняющий комментарий (кроме совсем очевидных, вроде end или операторных скобок).
и
Цитата:
Сообщение от Utkin
Даже i++ нуждается в комментарии
Это глупости. Код нужно документировать, а не комментировать. Хорошая документация заменяет кучу комментариев.
А уж про комментирование каждой строки так это вообще глупости. Сразу выдает студенческий уровень знаний. А все потому что нормальный программист понимает что такое if(...), else, i++ и иже с ними.

По сабжу - использую JavaDoc, jsDoc, YUIDoc.
MaTBeu вне форума Ответить с цитированием
Старый 03.01.2012, 13:31   #30
Utkin
Старожил
 
Аватар для Utkin
 
Регистрация: 04.02.2009
Сообщений: 18,136
По умолчанию

Вы не поняли сути - описывается не i++. Описывается алгоритм.
Цитата:
Сразу выдает студенческий уровень знаний.
Я бы был более осторожен в оценках и навешиваемых ярлыках.
Маньяк-самоучка
Utkin появился в результате деления на нуль.
Осторожно! Альтернативная логика
Utkin вне форума Ответить с цитированием
Ответ


Купить рекламу на форуме - 42 тыс руб за месяц

Опции темы Поиск в этой теме
Поиск в этой теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Правила написания кода на Delphi Virtson Общие вопросы Delphi 17 06.08.2010 08:59
Правила разделов/главные правила Alex Cones О форуме и сайтах клуба 1 30.09.2009 17:49
Оформления текста tae1980 Microsoft Office Excel 6 26.03.2009 18:54
Стили оформления кода Altera Свободное общение 2 30.08.2008 17:23
Проблема оформления SunKnight Общие вопросы Delphi 3 25.02.2008 01:11