JavaScript — напишите читаемый код

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

Не нарушайте соглашения об именах

Имена функций и частных переменных всегда должны быть в camelCase. Пишите конструкторы в PascalCase, а глобальные переменные и константы — в UPPER_CASE. Все должно быть названо на английском языке.

var MY_CONSTANT = “Uppercase”;
function myFunction() {
   var privateVar = "camelCase";
}
function Person(name){ // Constructor 
   this.name = name;
}
var kris = new Person("kris");

Относитесь к своим объектам как к замку

Зависимости должны быть включены как параметры в конструктор. Держите все свои переменные закрытыми, если они не должны быть общедоступными. Все переменные всегда должны быть установлены внутри класса. Правило номер один, ничто не должно изменять состояние объекта снаружи, объект должен иметь возможность изменять свое состояние только изнутри, как и замок. Это важно и для тестирования.

человек.js

(function () {    
   "use strict";
   function Person(name){
      this.name = name;
   }
   Person.prototype.updateName = function (newName) {
      this.name = newName;
   }
   window.Person = Person;
})();

main.js

(function () {
   "use strict";
   var kris = new Person("kris");
   kris.name = "fred"; // Don't do this! 
   // Don't change the state of the object from the outside !!
   kris.updateName("fred"); // This is fine!
})();

Не изобретайте колесо

Лучший читаемый код — это код, который вам никогда не понадобится читать. Есть так много хорошо протестированных и замечательных библиотек. Используйте их вместо написания собственного кода. Это также сэкономит вам много времени.

Организуйте свой код

Изображение, если вы ищете ошибку в файле с 2000 строками. Было бы неплохо, если бы код был структурирован таким образом, чтобы было легче найти то, что вы искали? Старайтесь всегда определять свои переменные вверху, затем ваши события и публичные функции и, наконец, ваши личные функции. Постарайтесь сохранить как можно больше логики и в ваших приватных функциях, это упростит обзор класса, того, что он делает и его функции.

(function (){
   "use strict";
   function Person(name){
      // Variables
      this.age = 30;
      this.name = name;
      // Public functions
      this.updateName = function(newName){
         doSomething();
         this.name = newName;
      }
      // Private functions
      function doSomething(){
        
         // Some Logic 
         
      }
   }
   window.Person = Person;
})();

Придерживайтесь того, что делает ваша команда

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

Нашли это полезным? Не забудьте подписаться на меня в twitter.

БТД

1CGu9Ctt1AuyXiWMJ2nEDoH1RRAKtStdjx

Эфириум

0xd2291b554075da7f61210db2648a7f0a2d006190