|
|
Регистрация Восстановить пароль |
Регистрация | Задать вопрос |
Заплачу за решение |
Новые сообщения |
Сообщения за день |
Расширенный поиск |
Правила |
Всё прочитано |
|
|
Опции темы | Поиск в этой теме |
02.01.2012, 12:34 | #1 |
Форумчанин
Регистрация: 02.07.2010
Сообщений: 167
|
Рекомендуемые правила оформления кода
Многие опытные программисты форума частенько жалуются на плохую читаемость кода. Конечно же каждый программист обладает так называемым "почерком" (стилем программирования). Но, согласитесь, у некоторых очень неразборчивые "почерки". Предлагаю тем, кто жалуется, в этой теме тезисно изложить рекомендуемые правила(от себя или где - нибудь общепринятые).
Если я тебе помог, помоги и ты мне +ом с комментарием
|
02.01.2012, 12:39 | #2 | |
Старожил
Регистрация: 12.01.2011
Сообщений: 19,500
|
Цитата:
Ушел с форума, https://www.programmersforum.rocks, alex.pantec@gmail.com, https://github.com/AlexP11223
ЛС отключены Аларом. |
|
02.01.2012, 15:38 | #3 |
Старожил
Регистрация: 12.11.2010
Сообщений: 8,568
|
Тема очень хорошая, ИМХО. Сам хотел обсудить оформление кода. У меня за время писания когда, можно сказать, выработался свой почерк... позже расскажу...
|
02.01.2012, 16:07 | #4 |
Старожил
Регистрация: 04.02.2009
Сообщений: 17,351
|
1. Практически каждая строка должна иметь поясняющий комментарий (кроме совсем очевидных, вроде end или операторных скобок).
2. Отступы в стиле Олмана - http://ru.wikipedia.org/wiki/%CE%F2%...E0%ED%E8%E5%29 3. Перед функцией/методом/процедурой обязательно: а) Зачем нужна эта функция/метод/процедура б) Краткая расшифровка всех входящих параметров в) Иногда расшифровка результатов (например -1 в случае неверных входящих параметров). 4. Разделяю все методы, классы и прочие важные функциональные единицы программы строкой состоящей из одних слешей типа: //////////////////////////////////////////////////////////////////////////////////////////////// Ну это на вскидку, может и еще чего делаю . Собственно конкретные детали не так уж и важны, главное чтобы оформление кода вообще имело место.
Маньяк-самоучка
Utkin появился в результате деления на нуль. Осторожно! Альтернативная логика Последний раз редактировалось Utkin; 02.01.2012 в 16:28. |
02.01.2012, 16:15 | #5 |
Участник клуба
Регистрация: 13.01.2009
Сообщений: 1,353
|
C/C++/C#
1. Параметры функции именую, начиная с "p" : pParameter и т.д. 2. Внутренние переменые функций именую, начиная с "_" _Data и т.д. 3. Свойства класса именую с большой буквы. 4. Поля класса именую с маленькой буквы. 5. Именование функций, делегатов, событий и прочего для меня не так важно. все они с большой буквы. Интуитивно пониманию по ключевым словам в имени. Это позволяет мне лучше ориентироваться в коде. Касательно разметки: Использую стиль Олмана. Остальное что я тоже делаю, написал Уткин. Очень долго свой подход разрабатывал, очень удобен и очень к нему привык.
"Тебе то может на меня и насрать, но твои глаза меня обожают!"
|
02.01.2012, 16:41 | #6 |
Interdicted
Участник клуба
Регистрация: 25.11.2010
Сообщений: 1,194
|
Как документировать код
Пример: Код:
- Табуляция 4 пробельных символа (именно пробельных символа, а не знак табуляции) - Примеры оформления: Код:
- Стараться умещать строку кода по ширине до 80 символов, на крайний случай до 120 - Названия переменных, классов, функций, методов и т.п. должны отражать суть, но не быть слишком длинными и не слишком короткими Love writing code and I am really passionate about it
Последний раз редактировалось Bustle; 02.01.2012 в 16:59. |
02.01.2012, 17:07 | #7 | |
C++, Java
Старожил
Регистрация: 10.04.2010
Сообщений: 2,665
|
Цитата:
|
|
02.01.2012, 17:09 | #8 |
Старожил
Регистрация: 04.02.2009
Сообщений: 17,351
|
Ну бывает . Но если включить какой-нибудь орган, то можно найти и так...
Маньяк-самоучка
Utkin появился в результате деления на нуль. Осторожно! Альтернативная логика |
02.01.2012, 17:20 | #9 |
Старожил
Регистрация: 17.11.2010
Сообщений: 18,922
|
Возможно стиль отступов и не определяющий (если нет особых требований привередливого заказчика), главно что бы они вообще были, и все ПО оформлено в одном стиле. В Delphi тоже без отступов читать код очень тяжело, другой раз на форуме выложат 10 строк кода без отступов, не только читать, но и смотреть противно
Если бы архитекторы строили здания так, как программисты пишут программы, то первый залетевший дятел разрушил бы цивилизацию
|
02.01.2012, 17:45 | #10 |
Старожил
Регистрация: 28.01.2009
Сообщений: 21,000
|
С++/C#
1)применяю стиль Олмана(1 таб, размером в 4 пробела). 2)у параметров у методов обычно ставлю нижнее подчеркивание, но не всегда, а обычно только тогда когда конфликт с именем поля(причем для списка инициализации) 3)поля пишу с малой буквы(обычно всегда private) 4)имена классов с большой буквы, и чтоб понятные были.* 5)обязательно использую namespace.* 6)в хидерах никаких using. 7)методы пишу с большой буквы(Scan, Clean) но get/set-методы чаще пишу с малой(getData) Делфи: 1)отступы по одному пробелу 2)классы как положенно с Т, предрекая имя класса префиксом 3)поля предрекаю F<имя> 4)методы с большой буквы(LoadFromFile) * Код:
Хорошо поставленный вопрос это уже половина ответа. | Каков вопрос, таков ответ.
Программа делает то что написал программист, а не то что он хотел. Функции/утилиты ждут в параметрах то что им надо, а не то что вы хотите. |
|
Похожие темы | ||||
Тема | Автор | Раздел | Ответов | Последнее сообщение |
Правила написания кода на 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 |