Чистые переменный

1. Используйте осмысленные имена переменных

Как не надо делать.

//Train's departure time
var time1 = new Date(2018, 1, 18);
//Train's arrival time
var time2 = new Data(2018, 1, 19);

Если Вам приходится писать объяснения на такие простые участки и код не может сам себя объяснить, то наверное Вы что то делаете неправильно ).

Как делать правильно:


var departureTime = new Date(2018, 1, 18); var arrivalTime = new Data(2018, 1, 19);

2. Переменные должны быть запоминающимися.

Большинство редакторов и IDE имеют возможность перемещаться по коду, указывая, например, имена классов или переменных.
В vscode, например, это можно сделать с помощью сочетания клавишь ctrl + shift + O и ctrl + E чтобы быстро перемещаться между файлами.

3. Использовать описательные имена вместо коротких

Например есть у нас такой объект.
Как не надо делать.

let person = {
    fName: 'John',
    lName: 'Smith',
    fatherName: 'Jake'
};

Через какое то время нам нужно вывести из него инфу — имя отца. intellisense показывает варианты, и нельзя однозначно сказать fName — это firstName или fatherName.

Как делать правильно:

let person = {
    firstName: 'John',
    lastName: 'Smith',
    fatherName: 'Jake'
};

4. Избегайте ненужного контекста

Например, есть такой пример. Где в классе Student переменные также содержать название класса. Так делать не нужно, потому что мы и так знаем в каком классе находимся.

Как не надо делать.

export class Student {
    constructor(
        studentAcademicId,
        studentFirstName,
        studentLastName,
        studentUniversity
    ) {
        this.studentAcademicId = studentAcademicId;
        this.studentFirstName = studentFirstName;
        this.studentLastName = studentLastName;
        this.studentUniversity = studentUniversity;
    }
}

Как делать правильно:

export class Student {
    constructor(
        AcademicId,
        FirstName,
        LastName,
        University
    ) {
        this.AcademicId = AcademicId;
        this.FirstName = FirstName;
        this.LastName = LastName;
        this.University = University;
    }
}

5. Делать в соответсви с соглашением по наименованию

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

export class Order {
    get () {

    }
}

export class Customer {

    //getCustomer() {

    //}

    //get_customer() {

    //}

    get() {

    }
}