Хороший код JavaScript

#jquery #хороший_тон #javascript #style_guide

Как лучше именовать переменные и функции?
Как комментировать код?
Чего лучше не делать?
...

Иными словами, интересует всё то, что облегчит поддержку кода как автору кода, так
и другим программистам.
Интересуют JavaScript и jQuery.    

Ответы

Ответ 1

Google JavaScript Style Guide


Ответ 2

В коментарии не влезло, посему пришлось писать, как ответ.
Знаете, какое одно из главных качеств, которым должен обладать любой программист?
Это - логика. Если вам это свойство не чуждо, то попробуйте ответить на свои же вопросы.

Функции (да и переменные) должны именоваться осмысленно, чтоб увидя ее, можно было
бы догадаться, что она делает или же, чтоб её можно было легко найти. Логично? Думаю да. 
Коментировать куски кода, желательно простым человеческим языком: кратко и информативно.
Вроде бы тоже логики не лишено.
Не изобретать колесо, а знать синтаксис, логику, методы и прочие особенности языка.

А в остальном, логично было бы в поисковике набрать что-то вроде: "Правила хорошего
тона в программировании", "Красивый код", "Правильное оформление кода", etc. Потому
как перечислить все тонкости, отвечая на вопрос, достаточно накладно.


Ответ 3

Насчёт чего лучше не делать - вот хорошая мини-презентация:

Ineffective JavaScript


Ответ 4

Для начала почитайте "Чистый код" Роберта Мартина (или найдите то, что вам больше
понравится), ваши вопросы относятся к программированию вцелом, не только к JavaScript.


Ответ 5

В дополнение, если крепкие нервы: JsLint к вашим услугам. 
Если верить их описанию, он как раз и оценивает "хорошесть" кода


Ответ 6

Крошка сын к отцу пришёл, и спросила кроха:
- Что такое хорошо и что такое плохо?
JavaScript Patterns Collection


Ответ 7

Этот навык приходит с опытом и оттачивается годами, если конечно уделять этому время
и внимание, глядя как пишут другие, читать статьи посвященные данной тематике, а где-то
и сам приходишь к пониманию как делать правильно и лучше. Поэтому все перечислить одним
ответом на ваш вопрос просто невозможно, могу лишь дать ссылку на руководство где я
собрал некоторые мысли о том как писать хороший код. Может быть какие-то приемы будут
вам полезны: руководство по оформлению JavaScript кода

Главное уделять этому внимание, время от времени гуглить и читать об этом. Лично
сам я так и делаю, поэтому и попал на ваш вопрос, подглядеть, что советуют люди, какие
новые приемы по улучшению коду придумали и так далее.


Ответ 8

Ещё рекомендации:

Оригинал: Airbnb JavaScript Style Guide
Перевод: Стиль написания кода на JavaScript для Uprock: Перевод и расширение "Airbnb
JavaScript Style Guide"

Плюс статья на Хабре о этом руководстве.