• 71692
  • 434
  • 33
Нравится блог?
Подписывайтесь!

Стиль кода

Какой стиль кода лучше? Там где я сейчас стажируюсь применяется первый...

  1. <?php
  2.  
  3. // 1 стиль
  4. function someFunc( $param, $param2 )
  5. {
  6. if( $param == 'some' )
  7. {
  8. return true;
  9. }
  10. elseif( $param2 == $param )
  11. {
  12. return 'ok';
  13. }
  14. }
  15.  
  16. // 2 стиль
  17. function someFunc( $param, $param2 ) {
  18. if ($param == 'some' )
  19. return true;
  20. elseif ($param2 == $param)
  21. return 'ok';
  22. }
  23.  
  24. // 3 стиль
  25. function someFunc($param, $param2){
  26. if ($param == 'some') return true;
  27. elseif ($param2 == $param) return 'ok';
  28. }
  29.  
  30.  
  31. ?>

Также интересует ваше мнение касательно комментирования кода. Нужно ли оно? И в каком виде? Меня пытаются отучить от этого дела, аргументируя это тем, что хватает нормального именования функций и переменных.

1ый, самый широкий
25.0% (5)
2ой, золотая(?) середина
20.0% (4)
3ий, краткий
0.0% (0)
В зависимости от сложности кода
30.0% (6)
Хочу посмотреть результат
25.0% (5)
25 декабря 2010, 19:00
722

Загрузка...
Loading...

Комментарии

kiRach
0
0
Для каждого языка есть свое соглашение. Не знаю, как в PHP, но в Java есть Code Convention. Придуман и написан он для того, чтобы код был понятен для всех программистов.
Ну а комментарии просто необходимы. Никакое нормальное название функции не сможет заменить пару строчек комментариев о том, для чего она предназначается. Отучивать от внесения комментариев в код - это вообще очень странно. Разве что ведется специальная документация, и в этой документации прописана каждая функция и переменная (опять же, аналог в java - JavaDoc'и).
faiwer
0
6
Документация не ведётся :)
kiRach
0
0
Ну тогда без комментариев в дальнейшем даже самому разработчику будет сложно поддерживать/рефакторить код. А уж если это будет другой программист, то он не раз вас вспомнит "хорошими словами":)
Больше нравится 1-й стиль, хотя чаще использую 3-й. Коментарии необходимы даже для самого себя. Работаю 8 лет в одном месте, написанное забывается за год-два.
xapon
0
0
Я стал любить вариант 1, потому что так лучше видно, где находятся парные скобки. Ну то есть { и } на одном горизонтальном уровне.
faiwer
0
6
Да, эта деталь мне тоже нравится. Но жутко бесит когда очень простой код занимает километры пространства. Будь моя воля, я бы использовал такой способ только в больших конструкциях, например сложных считчах, но приходится писать везде :)
xapon
0
0
Да, в коротких функциях это не удобно, но у меня почему-то почти не бывает таких коротких функций)
stalin
0
0
Сам придерживаюсь 2–го стиля. Комментирую свой код всегда, более менее подробно.

Вообще дико странное дело — отучать комментировать код, как–будто это страшно вредная привычка. Если бы еще так было...
Думаю, плохого стиля не бывает, если его везде соблюдать и он более-менее удобочитаем. Касательно вопроса - используй тот стиль, что применяется в компании, поверь, потом не пожалеешь.
Вообще это хороший тон - использовать тот стиль, что и во всем проекте, например на работе модули под друпал я пишу с использованием Drupal coding standards. Но даже для своих проектов я не изобретаю свои правила, для каждого языка думаю найдется распространенный стиль кода, скажем для PHP есть PEAR CS
EpeTuK
0
0
3-й стиль, конечно же, ужасен. Придерживаюсь 1-го стиля. Комментирование обязательно. Если не веду JavaDoc, то очень подробно описываю, при ведении же - описываю только наиболее сложные алгоритмы
quux
0
0
3 c одним исправлением:
function someFunc($param, $param2) {
if ($param == 'some') return true;
elseif ($param2 == $param) return 'ok';
}
faiwer
0
6
Похоже юви-парсер съел все различия =)
P.S. минусовал не я

Оставьте свой комментарий

Спасибо за открытие блога в Yvision.kz! Чтобы убедиться в отсутствии спама, все комментарии новых пользователей проходят премодерацию. Соблюдение правил нашей блог-платформы ускорит ваш переход в категорию надежных пользователей, не нуждающихся в премодерации. Обязательно прочтите наши правила по указанной ссылке: Правила

Также можно нажать Ctrl+Enter

Популярные посты

Инструкция для аллергиков. Как бороться с аллергией в период обострения

Инструкция для аллергиков. Как бороться с аллергией в период обострения

Я аллергик с детства. Имею аллергию на пыльцу березы, липы, полыни (выяснил это благодаря кожным пробам), а также пищевую аллергию на горчицу. Свои проблемы знаю, однако это меня не спасло.
Romeo_17
15 авг. 2017 / 17:21
  • 38518
  • 63
СМИ – ассистент провокаторов? Как гости из соседних стран сеют раздор в Казахстане

СМИ – ассистент провокаторов? Как гости из соседних стран сеют раздор в Казахстане

Инцидент с пьяным киргизским гостем на борту Air Astana, наверное, остался бы только во внутренних сводках авиакомпании, если бы г-н Доган, не поднял громкий крик о государственном языке.
openqazaqstan
вчера / 14:43
Алматы предложили сделать центром секс-туризма

Алматы предложили сделать центром секс-туризма

Известный политолог России Андрей Карпов предложил сделать Алматы центром секс-туризма. Но для этого сперва нужно легализовать проституцию в стране.
tala03
13 авг. 2017 / 14:48
Казахский национализм раньше выглядел несовременно. Теперь он другой

Казахский национализм раньше выглядел несовременно. Теперь он другой

Националисты стали совсем другими. По-английски хорошо говорят, русскую классику цитируют. Очень современные, образованные, адекватные. А после Крыма в националисты уже чуть ли не любой казах готов был записаться.
Aidan_Karibzhanov
16 авг. 2017 / 16:52
«Доехать до Алтын Орды» – как мошенники обманывают алматинцев

«Доехать до Алтын Орды» – как мошенники обманывают алматинцев

Из множества грустных откровений постепенно сложился перечень самых распространённых уловок охотников за нашими деньгами. В нём ожидаемо лидировали профессиональные попрошайки.
caravan_kz
16 авг. 2017 / 15:05
  • 1824
  • 2
Недоразумение с грантами в ВУЗы: «медалисты» до сих пор имеют преимущество

Недоразумение с грантами в ВУЗы: «медалисты» до сих пор имеют преимущество

Многие способные выпускники без Алтын Белги готовились к тестированию, чтобы в честной борьбе попытать счастья на гранты без ущемления со стороны якобы "золотых" выпускников.
DanaJarlygapova
14 авг. 2017 / 14:35
В Кокшетау строят два парка для молодёжи. Будут учтены интересы и любителей спорта

В Кокшетау строят два парка для молодёжи. Будут учтены интересы и любителей спорта

Общая площадь парка составляет 25 гектаров. На территории предусмотрено устройство прогулочных дорожек, площадок для установки аттракционов и павильонов различного назначения, цветников.
zhasakmola
вчера / 17:13
  • 1428
  • 1
На EXPO через Балхаш и Боровое своим ходом

На EXPO через Балхаш и Боровое своим ходом

Мы объехали по кругу озеро Иссык-Куль, о чем повествует предыдущий пост, и вернувшись из поездки подумали, а почему бы нам не рвануть на наше озеро, не менее прекрасное?
yelenasergiyenko
13 авг. 2017 / 13:13
  • 1377
  • 6
«Мы все дышим». Лучшие цитаты 5 серии 7 сезона «Игры престолов»

«Мы все дышим». Лучшие цитаты 5 серии 7 сезона «Игры престолов»

Нас подготовили к самой долгожданной битве за сезон. Встреча дракона и Джона. Старые записи мейстеров. Возвращение давно забытого героя. Интриги Мизинца. Новый «отряд самоубийц».
on_looker
15 авг. 2017 / 13:57
  • 1169
  • 10