Найти тему
Стать программистом

Общепринятные правила написания кода.

Оглавление
https://m03s6dh33i0jtc3uzfml36au-wpengine.netdna-ssl.com/wp-content/uploads/webapplog-logo-pink2.png
https://m03s6dh33i0jtc3uzfml36au-wpengine.netdna-ssl.com/wp-content/uploads/webapplog-logo-pink2.png

Капитализация

Имена связываний могут не содержать пробелов, но часто полезно использовать несколько слов, чтобы четко описать, что представляет собой связывание. Это в значительной степени ваш выбор для написания связующего имени с несколькими словами в нем:

fuzzylittleturtle // стиль №1
fuzzy_little_turtle // стиль №2
FuzzyLittleTurtle // стиль №3
fuzzyLittleTurtle // стиль №4

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

Так же общепринято писать все названия на английском языке, именно на английском языке, а не латинскими буквами, то есть не "pervoeChislo", а именно "firstNumber". С маленькой буквы первое слово и с заглавной второе.

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

https://bluerocksystems.co.uk/wp-content/uploads/2017/09/shutterstock_96602686for-web.jpg
https://bluerocksystems.co.uk/wp-content/uploads/2017/09/shutterstock_96602686for-web.jpg

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

Комментарии

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

Комментарий - это фрагмент текста, который является частью программы, но полностью игнорируется компьютером. У JavaScript есть два способа написания комментариев. Чтобы написать однострочный комментарий, вы можете использовать два символа косой черты (//), а затем текст комментария после него.

let accountBalance = CalculateBalance (account); // Ваш любой комментарий к строке, чтобы не забыть что он обозначает
accountBalance.adjust (); // Комментарий 2
let report = new Report (); // Комментарий 3
addToReport (accountBalance, report); // Комментарий 4
https://otvet.imgsmail.ru/download/8b2f3a7b35c038757660d86e6352321c_i-513.jpg
https://otvet.imgsmail.ru/download/8b2f3a7b35c038757660d86e6352321c_i-513.jpg

// Комментарий идет только до конца строки. Раздел текста между / * и * / будет полностью игнорироваться, независимо от того, содержит ли он разрывы строк. Это полезно для добавления блоков информации о файле или части программы.

/ *
Сначала я нашла этот номер, нацарапанный на обратной стороне старого блокнота. С тех пор она часто появляется в телефонах и на серийных номерах приобретенных мною товаров. Очевидно, я ему нравлюсь, так что я решил оставить его себе.
* /
const myNumber = 11213;

Благодарю за прочтение статьи. Подписывайтесь на канал "Стать программистом"