javascript-programming-tutorial/JS_18_script_code_style.html at master · paulinelemenkova/javascript-programming-tutorial · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<!DOCTYPE html>
<html>

    <head>
        <meta charset="utf-8">
    </head>

    <body>
        <script>
        "use strict";
        // https://learn.javascript.ru/coding-style

        // Фигурные скобки
        // Максимальную длину строки согласовывают в команде. Как правило, это либо 80, либо 120 символов
        // Более длинные строки необходимо разбивать для улучшения читаемости.
        // Отступы. Отступы нужны двух типов:

        // 1. Горизонтальный отступ, при вложенности – два(или четыре) пробела.

        show("Строки" +
             " выровнены" +
             " строго" +
             " одна под другой");

        // 2. Вертикальный отступ, для лучшей разбивки кода – перевод строки. Используется, чтобы разделить логические блоки внутри одной функции.
        // Используется, чтобы разделить логические блоки внутри одной функции.
        // В примере разделены инициализация переменных, главный цикл и возвращение результата:

        function pow(x, n) {
            var result = 1;
            //              <--
            for (var i = 0; i < n; i++) {
                result *= x;
            }
            //              <--
            return result;
        }

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

        //Справочный комментарий перед функцией – о том, что именно она делает, какие параметры принимает и что возвращает.
        // Для таких комментариев существует синтаксис JSDoc:

        /**
         * Возвращает x в степени n, только для натуральных n
         *
         * @param {number} x Число для возведения в степень.
         * @param {number} n Показатель степени, натуральное число.
         * @return {number} x в степени n.
         */
        function pow(x, n) {
            ...
        }

        // …Но куда более важными могут быть комментарии, которые объясняют не что, а почему в коде происходит именно это! Как правило, из кода можно понять, что он делает. Бывает, конечно, всякое, но, в конце концов, вы этот код видите. Однако гораздо важнее может быть то, чего вы не видите! Комментарии, которые объясняют выбор решения и алгоритма, очень важны. Они помогают понять происходящее и предпринять правильные шаги при развитии кода.
        // В хорошем коде должно быть минимум неочевидного. Но там, где это есть – пожалуйста, комментируйте.
        // Когда написанием проекта занимается целая команда, то должен существовать один стандарт кода, описывающий где и когда ставить пробелы, запятые, переносы строк и т.п.

        Почему это сделано именно так?
        </script>
    </body>

</html>