JavaScript code style. Стоит ли использовать объявления переменных внутри цикла?

Question

[Vetal Matitskiy]

Доброго дня, уважаемые гуру JavaScript. Помогите, пожалуйста, разобратся с вопросом о допустимости объявления перменных внутри цикла. В книгах авторитетных авторов обычно рекомендуется все переменные внутри функции объявлять внутри одного блока var, что-то в стиле
var url, price, i, j;
при этом на известных ресурсах, например javascript.ru в примерах часто используют варианты
for (var i=0;i<10; i++) {}
Есть ли какие-то стандарты в плане промышленного кодирования, о том какой вариант предпочтительнее,?

Comments

[wittyrider]

Переходите на ES2015, и забудьте var как страшный сон

[Vetal Matitskiy]

это вопрос к производителям браузеров

[sanex3339]

Vetal Matitskiy: а babel, что, отменили?

Answer 1

[Алексей Уколов]

Конечно, кажется что, выносить в начало функции переменную i - глупо. Но стоит дать ей осмысленное название (itemIndex, например или что-то более конкретное) и разбить код на небольшие функции, как все предрассудки исчезают.

Comments

[Sarkis Arutiunian]

я бы все же не рекомендовал такой способ, какой смысл ну хотя бы хранить в памяти переменную в которой будет записно что то, что использовалось пару раз в цикле и все? а при обьявлении в цикле, после работы самого цикла и сама переменная с памяти убирается, и глаза не мазолит, ну и читается это лучше. Если 90% пишут так, зачем изобретать велосипед? что бы другие не могли твой код поправить?))

[Vetal Matitskiy]

переменная объявленная как var доступна во всем теле функции, в которой она находится. просто до цикла у нее будет значение undefined

[Алексей Уколов]

Sarkis Arutiunian: вы ошибаетесь. Внутри цикла переменную объявить нельзя, она объявляется в его объявлении. И эти две записи абсолютно идентичны:
for (var i = 0; i < 5; i++) {}

var i;
for (i = 0; i < 5; i++) {}

Только вот вторая как раз не только общепринятое соглашение (выносить все объявления переменных в начало области видимости), но и принуждает использовать нормальные имена переменных, вместо однобуквенных, чтобы не запутаться.

[Алексей]

Алексей Уколов Второй способ в теории более производительный, т. к. переменная объявляется только один раз, а не при каждой итерации, но все современные интерпретаторы, вроде, давно это оптимизируют.

Советую остановиться на первом общепринятом способе - не выносить объявление переменной и использовать стандартные именования для итераторов - верхнего уровня - i, второго - j, третьего - k и.т.д. Внутри цикла всем будет читаться гораздо лучше чем какая-то другая переменная.

[Алексей Уколов]

Murmurianez: именно поэтому я про оптимизацию ничего не сказал - она ничтожна. А вот использовать однобуквенные переменные, да еще и со вложенными циклами, это прямой путь к багам и головной боли. У каждой переменной должно быть осмысленное название, отражающее ее суть. Да, если цикл простой можно проигнорировать здравый смысл и дать итератору однобуквенное имя. Или если это какой-то тестовый код или пример на коленке. Или если вы сознательно хотите осложнить жизнь себе и коллегам.
Я свой выбор сделал :)

[Алексей]

Алексей Уколов Не, ну i, j, k и т.д. (не a, b, c, не x, y, z...) это принятый стандарт (любую книгу по программированию, не только по js, откройте) и при правильном использовании говорят о конкретной вещи - вложенность именно в таком порядке. Вот если кто-то поменяет их порядок - сломает мозг. Бывают случаи когда даёшь итераторам более осмысле имена, но это скорее исключение. А к багам и головной боли приводит излишне длинный код.

[Sarkis Arutiunian]

Алексей Уколов: я и имел в виду в обьявлении. Про обще принятую, ну незнаю не знаю, даже в jquery обьявляется так. Опять простой плюс преимущество не плодить переменные ну и опять, в большом коде это избавит от множества возможных багов. Но дело ваше, ведь ваш код, ваш стиль)

[Алексей Уколов]

Sarkis Arutiunian: группировка объявления переменных в начале области видимости и адекватные их имена - гораздо более надежная защита от багов. Ну и декомпозиция громоздких функций на более мелкие.

[Sarkis Arutiunian]

Алексей Уколов: окей, если речь про простые переменные, для функций и тп, но это переменные для ЦИКЛА, скажем так однаразоввые переменные, которые не нуны ни в замыкании видимости ни в памяти да и вообще ни где кроме самого процесса цикла. Выше в коменте от Murmurianez очень грамотно описано зачем и почему в циклах принято использовать i, j, k и тп.

[Алексей Уколов]

Sarkis Arutiunian: в памяти они будут в любом случае. И вынося их в начало области видимости вы как раз показываете, что вы это понимаете. То, что принято использовать однобуквенные переменные ничего не значит, раньше и goto было принято писать :)
Переменная - это кусок документации. Наличие у переменной содержательного имени позволяет не писать комментарии, например - по коду итак понятно что в нём происходит.
У однобуквенных переменных есть очень узкая область применения - это небольшие циклы и, ни в коем случае, не вложенные. Иначе, код становится нечитаемым и, следовательно, уязвимым для багов.
Но даже если и использовать однобуквенные переменные, их объявление всё равно нужно выносить в начало области видимости, потому что именно так работает javascript и это общепринятый стандарт написания кода.

[Sarkis Arutiunian]

Алексей Уколов: ну могу только посоветовать перечитать книжки.
1. Из памяти чистятся все переменные, функции и обьекты на которые нет ссылок (нет обращения из вне).
2. документацие к коду будет служить написанная спецификация (код для автотестов различных функций) а не переменные вначале однйфункции или кода.
3. Наверное большинство программистов и создатели известных фреймворков настолько не далекие что придерживаются именно этого метода?))

[Алексей Уколов]

Sarkis Arutiunian: про книги могу сказать то же самое :)
1. Объявление переменной в js всплывает к началу области видимости. От того, где внутри области видимости вы объявите переменную потребление памяти не изменится ни на байт.
2. Скажите, как удобнее понять, что делает код:
- прочитать его
- прочитать его, найти его тесты, открыть их, прочитать их (попеременно поглядывая в код)?
3. Не нужно понтоваться авторитетами :) То о чём я пишу, разумеется, имеет далеко не самое важное значение для чистоты кода. Поэтому, если забить на это, ничего особенно страшного скорее всего не случится. Это как с чисткой зубов дважды в день - скорее всего, если вы на это забьете, то ничего плохого не случится (только пахнуть будет плохо), но вот если случится, придется заплатить круглую сумму стоматологу. Но гораздо надежнее подстраховаться заранее, чтобы потом не сожалеть.

Суммирую:
- Вынос объявления переменных в начало области видимости - это промышленный стандарт. Делать исключение конкретно для циклов я не вижу смысла - зачем вносить дополнительную сложность в виде особых случаев, туда, где она не требуется?

- Названия переменных должны быть описательными и понятными. Да, i - это принятое соглашение, но оно теряет смысл как только его вынесли на десять строк кода от цикла в начало функции. А если циклов в функции несколько, то и запутаться недолго. Конечно, можно оставить и однобуквенное название, но это опять же исключение из правила, которое только добавляет путаницы. Гораздо проще дать переменной нормальное имя и двигаться дальше.

Вы только два аргумента привели: "это экономит память" и "а чо, все так делают". Первый не соответствует действительности, а второй очень неубедительный.

[Алексей Уколов]

Digital Brain, спасибо, что я не одинок :)

[Sarkis Arutiunian]

Алексей Уколов: просто на заметку: stackoverflow.com/questions/19986212/is-it-best-to...

так же на заметку, погуглите про цикли и общепринятые стили ну хотя бы в именах переменных.

Для меня спор закрыт, это уже похоже на детский сад, когда кто то ни как не признает свою ошибку) Удачи.

[Алексей Уколов]

Sarkis Arutiunian: а, вот в чем дело - для вас это спор, а для меня обсуждение. Но в споре принято выдвигать аргументы, на ваши я уже ответил.

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

Для меня спор закрыт, это уже похоже на детский сад, когда кто то ни как не признает свою ошибку

Во-первых, в данном вопросе могут быть только мнения, но ни как не единая истина. Во-вторых, если уж говорить про детский сад, то ваше поведение больше подходит под это определение - я вам полчаса писал аргументированный ответ, а вы на это ответили "Всё, я обиделся, не буду с тобой играть".

[Алексей Уколов]

Sarkis Arutiunian: просто скажите, у вас кроме тех двух указанных выше аргументов есть еще какие-то? Хотите что-нибудь ответить на мои контраргументы?

У меня нет цели вас переубедить, я эту дискуссию веду больше для автора вопроса (ну и для тех, кто его потом будет читать). Поэтому, хочется подвести итог (не кто победил, а какие есть плюсы и минусы у данного подхода).

[Dmitriy Mozgovoy]

Алексей Уколов: хех... развели тут дебаты=)
Насчет выноса Вы точно не одиноки, я обеими руками "за". Хотя бы писать лишние var это некошерно, возможно минификатор их потом вверх и выносит (я не проверял), но лучше сразу сэкономим 3 байта=)) И не искать объявлял ли ты уже эту переменную в цикле с var, или нет, ведь ее можно повторно в следующем цикле использовать, а не плодить их.
Насчет осмысленного именования прям всех переменных типичных циклов, если их немного вложенных, то я наверно склоняюсь к i, j, k, хотя j пытаюсь обходить стороной, если хожу по осям координат- беру x,y,z. В принципе да, если брать за стандарты js стандарты C, то i, j, k устоявшиеся имена переменных для циклов, в pascal (да будет ему земля пухом =) ), в книгах вообще часто брали m, n и еще какая то. Но, если действительно переменная цикла имеет какой то специфический смысл, то почему бы ее не назвать уникальным именем. JS совсем молодой в качестве серьезного языка разработки, все coding style вырабатываются по ходу дела- вряд ли есть тут "черное" и "белое".

Answer 2

[Sarkis Arutiunian]

в es6 есть крутая штука let, вот ее стоит использовать для обьявления переменных в цикле, это лучше чем var и не нужно заморачиваться с замыканием.

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

Answer 3

[Андрей Данилов]

for (var i = 0; i < 10; i++) { }


В данном случае, переменная var i объявлена не в теле цикла, а в его условии – по крайней мере, острой необходимости в микрооптимизации здесь нет.
А относительно стиля, можно сказать что такой вариант наболее читаемый.

Answer 4

[Dmitriy Mozgovoy]

В текущем ES5 я все переменные выношу в общий var.
С точки зрения движков браузеров это ничем не лучше, ибо все ровно видимость переменной на всю функцию , но, ИМХО, читаемость выше и контролировать набор переменных проще, включая рациональность их использования, чем ловить их по телу функции, кто и где там var объявил и не продублировал ли где. Вполне возможно, что переменная счетчика будет использоваться повторно, если код синхронный. Так что никаких var в циклах у меня нет.
Тут сколько программистов - столько и code style. Я еще в var переменные разбиваю по функциональных группах:

var url, 
    price, weight,
    x, y;

  for (x = 0; x < 10; x++) {
    for (y = 0; y < 10; y++) {

    }
  }